Ubah tipe TypeScript menjadi JSON!

Masukkan interface TypeScript untuk membuat contoh JSON! Mendukung TypeScript interface, type. Berguna untuk dokumentasi API dan body request uji (mock request body).
TypeScript
Hasil
 

Ubah tipe TypeScript menjadi JSON!

Tempel deklarasi interface, alias type, enum atau class TypeScript dan dapatkan contoh dokumen JSON yang memenuhinya. Literal union, Record, utility type seperti Pick, Omit dan Partial, serta interface yang dirangkai dengan extends semuanya ditelusuri dan diisi.

Gunakan sebelum API tersedia untuk menyiapkan mock data MSW atau json-server, membuat props Storybook, atau menunjukkan ke tim backend persis bentuk apa yang Anda ingin mereka kirim.

Cara menggunakan

  1. Tempel deklarasi tipe dari file seperti types.ts. export, import dan deklarasi fungsi boleh tercampur; hanya deklarasi tipe yang dibaca.
  2. Sertakan tipe dan enum yang direferensikan agar ikut terisi. Nama tipe yang tidak ada di input menjadi null.
  3. Tidak ada opsi. Tipe objek pertama yang tidak direferensikan deklarasi lain menjadi root, jadi letakkan yang Anda inginkan di urutan pertama; alias yang mengisi sebuah generic, seperti type UserPage = Page<User>, lebih diutamakan daripada deklarasi generic itu sendiri.
  4. Salin hasilnya ke HttpResponse.json(...) di handler MSW, test fixture, atau args Storybook, lalu sesuaikan nilainya.

Contoh

Input (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 }
Output (JSON)
{
  "id": "",
  "channel": "email",
  "priority": "low",
  "recipient": {
    "userId": 0,
    "locale": ""
  },
  "payload": {
    "key": ""
  },
  "readAt": "1970-01-01T00:00:00.000Z",
  "meta": {
    "createdBy": ""
  }
}

Channel adalah string literal union, jadi mengambil nilai pertamanya "email"; string enum Priority mengambil nilai member pertamanya "low". Record<string, string> menjadi objek dengan satu "key", Date | null diselesaikan ke sisi non-null sebagai string ISO, dan Pick<Audit, "createdBy"> hanya mempertahankan key yang dipilih. locale? yang opsional juga disertakan.

Fitur yang didukung

  • Primitive: string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (format Date.toJSON()).
  • Literal type memakai nilainya, union mengambil anggota pertama yang bukan null/undefined, dan intersection (A & B) serta interface ... extends menggabungkan properti.
  • enum memakai nilai member pertamanya, atau 0 untuk enum numerik tanpa initializer.
  • Array, Array<T> dan Set<T> mendapat satu elemen contoh; tuple mendapat nilai untuk setiap posisinya; Record<K, V>, Map dan index signature menjadi {"key": V}.
  • Mendukung utility type Partial, Required, Readonly, NonNullable, Pick dan Omit.
  • Method dan properti bertipe fungsi tidak ada di JSON sehingga dibuang; di class, field static, accessor get/set, dan field @Exclude() dikecualikan.
  • Array yang mereferensikan dirinya sendiri (children: TreeNode[]) dipotong menjadi array kosong.

Kasus penggunaan

Mock response untuk MSW atau json-server

Sebelum backend siap, buat mock data dari tipe respons API. UI bisa dibangun lebih dulu, dan saat nanti beralih ke API sebenarnya, tipenya tetap sama.

Props untuk Storybook dan test

Buat objek default dari tipe props sebuah komponen untuk args story atau data render React Testing Library. Setiap properti wajib sudah ada, jadi tidak ada error tipe yang perlu dikejar.

Menyepakati format request dengan backend

Ubah tipe request frontend menjadi JSON lalu tempel ke dokumen desain API atau issue, sehingga developer backend yang tidak memakai TypeScript bisa langsung membaca strukturnya.

Catatan dan batasan

  • Properti opsional (?) selalu disertakan; hapus key-nya sendiri untuk menguji respons ketika key itu tidak ada.
  • Parameter generic disubstitusi di tempat tipe dipakai: dengan type UserPage = Page<User>, items: T[] diisi dengan User, dan default seperti <T = string> berlaku jika tidak ada argumen. Conditional type di dalam generic tetap tidak dievaluasi.
  • Indexed access type seperti T["key"], conditional type, dan template literal type tidak dievaluasi.
  • Field class yang diinisialisasi dengan satu literal (name = "kim", retries = 3) memakai nilai itu; initializer lain seperti new Date() hanya menjadi petunjuk tipe.
  • Kode schema runtime seperti Zod atau io-ts tidak dibaca; tuliskan tipe hasil z.infer sebagai interface biasa.
  • Map dan Set ditampilkan sebagai objek dan array, tetapi JSON.stringify mengubah keduanya menjadi {}, jadi utamakan Record atau array di tipe respons.

FAQ

Apakah benar Date keluar sebagai string?

Ya. JSON.stringify mengganti Date dengan hasil toJSON()-nya, yaitu string ISO 8601. Sisi penerima tetap mendapat string, jadi beri tipe string atau parse nilainya.

Nilai mana yang didapat union seperti status: "active" | "inactive"?

Literal pertama sesuai urutan deklarasi, "active". Ubah urutan union jika Anda lebih suka menampilkan nilai lain.

Apakah bisa dipakai dengan class DTO NestJS?

Deklarasi class dan decorator di-parse, jadi DTO yang diberi decorator class-validator terkonversi dengan baik, dan field @Exclude() dari class-transformer tidak disertakan.

Bagaimana cara dari JSON ke tipe TypeScript?

Gunakan halaman JSON → TypeScript untuk arah sebaliknya. Halaman terpisah juga membuat JSON dari model TypeORM, Sequelize, dan Mongoose.