Gunakan generator JSON ke TypeScript ini untuk membuat antarmuka dan tipe yang aman dari sampel JSON untuk aplikasi frontend dan layanan Node.js.
Langkah 1 – Tempelkan sampel JSON
- Tempelkan objek atau larik JSON yang representatif ke editor kiri.
- Sertakan objek bertumpuk, array, dan bidang nullable sehingga jenis dapat disimpulkan dengan benar.
- Gunakan
Import untuk memuat JSON dari file, URL, atau data sampel.
Langkah 2 – Pilih opsi pembuatan TypeScript
- Tetapkan
Root Type Name yang cocok dengan model Anda (misalnya Root). - Pilih strategi penanganan null (
Optional (?) vs Union (| null)) agar sesuai dengan dasar kode Anda. - Putuskan apakah Anda menginginkan alias
interfaces atau type untuk keluarannya.
Langkah 3 – Tinjau kode yang dihasilkan
- Periksa nama bidang, tipe, dan bagaimana array/objek dimodelkan.
- Sesuaikan opsi seperti
Root Type Name, penanganan null, dan kerangka kerja jika tersedia. - Jika suatu bidang disimpulkan dengan salah, sesuaikan sampel JSON Anda dan buat ulang.
Langkah 4 – Gunakan tipe yang dihasilkan
- Tempel hasilnya ke proyek Anda dan diekspor dari modul tipe Anda.
- Gunakan tipe untuk respons API, DTO, dan batas waktu penguraian proses.
- Buat ulang ketika payload JSON Anda berubah untuk menjaga klien tetap tenggelam.
Langkah 5 – Salin atau unduh
- Salin hasilnya ke proyek Anda atau unduh sebagai file.
- Jalankan formatter/linter Anda agar sesuai dengan gaya kode Anda.
- Tambahkan pustaka penguraian/serialisasi JSON jika bahasa Anda memerlukannya.
Contoh keluaran (disederhanakan)
// masukan JSON
{
"id": 123,
"name": "Maeve Winters",
"email": "[email protected]",
"active": true,
"roles": ["admin", "editor"],
"metadata": { "plan": "pro" },
"createdAt": "2024-03-01T10:15:00Z",
"score": 99.5,
"notes": null
}
// Generated TypeScript types (simplified)
export interface Metadata {
plan: string;
}
export interface Root {
id: number;
name: string;
email: string | null;
active: boolean;
roles: string[];
metadata: Metadata;
createdAt: string;
score: number;
notes: null;
}