Chuyển kiểu TypeScript thành JSON!

Nhập interface TypeScript để tạo JSON mẫu! Hỗ trợ TypeScript interface, type. Hữu ích cho tài liệu API và request body thử nghiệm (mock request body).
TypeScript
Kết quả
 

Chuyển kiểu TypeScript thành JSON!

Dán khai báo interface, type alias, enum hoặc class của TypeScript để nhận một tài liệu JSON ví dụ thỏa mãn chúng. Literal union, Record, utility type như Pick, Omit và Partial, và interface nối nhau bằng extends đều được lần theo và điền giá trị.

Dùng nó trước khi có API để chuẩn bị dữ liệu giả cho MSW hay json-server, tạo props cho Storybook, hoặc cho đội backend thấy chính xác hình dạng bạn muốn họ gửi.

Cách sử dụng

  1. Dán khai báo kiểu từ file như types.ts. export, import và khai báo hàm có thể lẫn vào; chỉ khai báo kiểu được đọc.
  2. Đưa vào cả các kiểu và enum được tham chiếu để chúng được điền giá trị. Tên kiểu không có trong đầu vào thành null.
  3. Không có option nào. Kiểu object đầu tiên không bị khai báo nào khác tham chiếu sẽ thành gốc, nên hãy đặt kiểu bạn muốn lên đầu; alias điền tham số cho generic, như type UserPage = Page<User>, được ưu tiên hơn chính khai báo generic.
  4. Sao chép kết quả vào HttpResponse.json(...) của handler MSW, test fixture hoặc args của Storybook, rồi chỉnh giá trị.

Ví dụ

Đầu vào (TypeScript)
type Channel = "email" | "sms" | "push";

enum Priority { Low = "low", High = "high" }

interface Notification {
  id: string;
  channel: Channel;
  priority: Priority;
  recipient: { userId: number; locale?: string };
  payload: Record<string, string>;
  readAt: Date | null;
  meta: Pick<Audit, "createdBy">;
}

interface Audit { createdBy: string; createdAt: Date }
Đầu ra (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel là string literal union nên lấy giá trị đầu tiên "email"; string enum Priority lấy giá trị member đầu tiên "low". Record<string, string> thành object có một "key" duy nhất, Date | null được phân giải sang phía không null thành chuỗi ISO, và Pick<Audit, "createdBy"> chỉ giữ key được chọn. locale? tùy chọn cũng được đưa vào.

Tính năng hỗ trợ

  • Kiểu nguyên thủy: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (định dạng của Date.toJSON()).
  • Literal type dùng chính giá trị của nó, union lấy thành viên đầu tiên không phải null/undefined, còn intersection (A & B) và interface ... extends gộp các property lại.
  • enum dùng giá trị của member đầu tiên, hoặc 0 với numeric enum không có initializer.
  • Mảng, Array<T> và Set<T> có một phần tử mẫu; tuple có một giá trị cho mỗi vị trí; Record<K, V>, Map và index signature thành {"key": V}.
  • Hỗ trợ các utility type Partial, Required, Readonly, NonNullable, Pick và Omit.
  • Method và property có kiểu hàm không tồn tại trong JSON nên bị bỏ; trong class, field static, accessor get/set và field @Exclude() bị loại.
  • Mảng tự tham chiếu (children: TreeNode[]) bị cắt thành mảng rỗng.

Trường hợp sử dụng

Response giả cho MSW hoặc json-server

Khi backend chưa sẵn sàng, hãy tạo dữ liệu giả từ kiểu response của API. UI có thể được dựng trước, và sau này chuyển sang API thật vẫn giữ nguyên các kiểu.

Props cho Storybook và test

Tạo object mặc định từ kiểu props của component để làm args cho story hoặc dữ liệu render cho React Testing Library. Mọi property bắt buộc đều có mặt, nên không phải đuổi theo lỗi kiểu.

Thống nhất định dạng request với backend

Biến kiểu request phía frontend thành JSON rồi dán vào tài liệu thiết kế API hoặc issue, để lập trình viên backend không dùng TypeScript cũng đọc được cấu trúc ngay.

Lưu ý và giới hạn

  • Property tùy chọn (?) luôn được đưa vào; hãy tự xóa key để test response khi chúng vắng mặt.
  • Tham số generic được thay thế tại chỗ kiểu được dùng: với type UserPage = Page<User>, items: T[] được điền bằng User, và mặc định như <T = string> được áp dụng khi không có đối số. Conditional type bên trong generic vẫn không được tính.
  • Indexed access type như T["key"], conditional type và template literal type không được tính.
  • Field class được khởi tạo bằng một literal duy nhất (name = "kim", retries = 3) dùng giá trị đó; các initializer khác như new Date() chỉ gợi ý về kiểu.
  • Code schema lúc runtime như Zod hay io-ts không được đọc; hãy viết kiểu do z.infer suy ra thành interface thông thường.
  • Map và Set hiển thị thành object và mảng, nhưng JSON.stringify biến cả hai thành {}, nên trong kiểu response hãy ưu tiên Record hoặc mảng.

Câu hỏi thường gặp

Date ra dạng chuỗi có đúng không?

Đúng. JSON.stringify thay Date bằng kết quả toJSON() của nó, một chuỗi ISO 8601. Phía nhận vẫn nhận được chuỗi, nên hãy khai báo kiểu là string hoặc parse nó.

Union như status: "active" | "inactive" nhận giá trị nào?

Literal đầu tiên theo thứ tự khai báo, "active". Hãy sắp xếp lại union nếu bạn muốn hiển thị giá trị khác.

Có dùng được với class DTO của NestJS không?

Khai báo class và decorator đều được parse, nên DTO gắn decorator của class-validator chuyển bình thường, và field @Exclude() của class-transformer bị bỏ ra.

Làm sao đi từ JSON sang kiểu TypeScript?

Hãy dùng trang JSON → TypeScript cho chiều ngược lại. Các trang riêng khác cũng tạo JSON từ model TypeORM, Sequelize và Mongoose.