Generator TypeScript Class ke JSON Schema

Input Kode TypeScript

Memuat editor…

Output JSON Schema

Pengaturan

Pilih interface/type yang harus diperlakukan sebagai root JSON Schema.

Parsing berjalan sepenuhnya di browser Anda. Sumber Anda tidak pernah meninggalkan halaman.

Tempel tipe TypeScript Anda untuk menghasilkan JSON Schema secara instan.

Mendukung interface, type alias, field class publik, modifier optional/readonly, dan union type.

Cara mengonversi interface, type, dan class TypeScript menjadi JSON Schema – panduan langkah demi langkah

Konverter interface TypeScript ke JSON Schema online ini membantu Anda menghasilkan JSON Schema dari model nyata (DTO, struct, dan class) sehingga Anda dapat memvalidasi payload, membagikan kontrak, dan membuat JSON mock.

  1. Langkah 1 – Tempel sumber TypeScript Anda

    • Tempel model yang ingin Anda dokumentasikan ke editor kiri.
    • Sertakan tipe yang direferensikan dalam snippet yang sama agar schema dapat menghasilkan definitions.
    • Gunakan tombol Contoh untuk memuat contoh dan melihat format input yang diharapkan.
  2. Langkah 2 – Pilih Tipe root (jika perlu)

    • Jika beberapa definisi terdeteksi, pilih root yang cocok dengan payload API Anda.
    • Output schema dibangun berdasarkan root yang dipilih dan dapat menyertakan definisi tambahan untuk tipe yang direferensikan.
  3. Langkah 3 – Tinjau output JSON Schema

    • Periksa tipe, field wajib vs opsional, serta struktur objek/array bersarang.
    • Cari definitions dan $ref saat model Anda mereferensikan model lain.
    • Salin atau unduh schema untuk validasi, dokumentasi, atau pengembangan schema-first.
  4. Langkah 4 – Validasi atau buat JSON mock

    • Klik Buat Data Mock untuk membuka mock generator dengan schema Anda yang sudah dimuat.
    • Validasi payload nyata terhadap schema untuk menangkap breaking change lebih awal.
    • Jika Anda mengandalkan komposisi schema lanjutan (misalnya anyOf/oneOf/allOf), verifikasi hasilnya dengan validator penuh seperti Ajv.

Catatan dukungan keyword schema

Schema yang dihasilkan dapat menyertakan $ref dan bisa diedit untuk menyertakan anyOf, oneOf, atau allOf. Untuk schema yang kompleks, gunakan validator JSON Schema penuh dan lakukan dereference sebelum membuat mock jika diperlukan.

Alat JSON Schema & pembuatan kode terkait

Gunakan alat-alat ini untuk memvalidasi schema, menghasilkan payload mock, memformat contoh JSON, dan menjaga sinkronisasi kode serta kontrak.

Pertanyaan yang Sering Diajukan

Sintaks TypeScript apa yang didukung?

Interface, type alias, dan class dengan field publik akan diparsing. Properti opsional, modifier readonly, key string-literal, union type, array, Record, dan reference bersarang didukung. Komentar dan decorator diabaikan sehingga Anda dapat menempel DTO langsung dari proyek Anda.

Bagaimana pemetaan tipe bekerja?

Tipe primitif (string, number, boolean, bigint, Date) dipetakan ke primitif JSON Schema dengan format yang sesuai. Array (Foo[] atau Array<Foo>), Record<string, T>, dan bentuk seperti dictionary menjadi schema array/objek. Union type yang menyertakan null/undefined secara otomatis menandai field sebagai opsional.

Bisakah dipakai untuk class maupun interface?

Ya. Selama class mendefinisikan field publik (atau properti readonly) dengan anotasi tipe, class tersebut akan dikonversi menjadi JSON Schema. Alat ini berjalan sepenuhnya di browser Anda, sehingga kode tidak pernah meninggalkan mesin Anda.

Bagaimana mendapatkan JSON mock dari schema?

Setelah schema dibuat, klik "Buat Data Mock" untuk membuka Mock Generator dengan schema yang sudah dimuat. Konfigurasikan locale, ukuran array, dan field opsional untuk menghasilkan payload contoh secara instan.

Generator TypeScript Class ke JSON Schema | JSONSwiss