JSON Schema ke TypeScript
Ubah JSON Schema menjadi tipe TypeScript. Objek menjadi antarmuka dengan properti wajib dan opsional, $defs serta definisi menjadi ekspor bernama yang dituju oleh $ref, enum dan const menjadi tipe literal, anyOf dan oneOf menjadi union, sedangkan allOf menjadi irisan. Deskripsi dipertahankan sebagai komentar dokumentasi.
Pertanyaan yang sering diajukan
Draft Skema JSON mana yang didukung?
Konverter membaca kata kunci yang digunakan bersama oleh draft-07, 2019-09 dan 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf, serta $ref ke $defs atau definitions. Kata kunci validasi seperti minLength atau pattern tidak memiliki padanan TypeScript dan diabaikan.
Bagaimana referensi $ref diselesaikan?
Referensi ke #, #/$defs/Name, dan #/definitions/Name menjadi tipe bernama dari definisi tersebut. Referensi lainnya, seperti ke file lain atau URL, diberi tipe unknown dan dicantumkan dalam komentar di bagian atas output.
Bagaimana additionalProperties ditangani?
Objek tanpa properti dan dengan skema additionalProperties menjadi Record<string, T>. Objek dengan properti dan skema additionalProperties menjadi antarmuka yang digabungkan dengan Record<string, T>. additionalProperties false atau kata kunci yang tidak ada tidak menambahkan apa pun, karena tipe objek TypeScript sudah menjelaskan kunci yang diketahui.
Apa fungsi nullable?
Kata kunci OpenAPI 3.0 nullable: true dan ekstensi Swagger x-nullable menambahkan | null ke tipe. Dalam JSON Schema itu sendiri, tulis type: ["string", "null"], yang menjadi string | null.
Apakah skema rekursif didukung?
Ya. Definisi yang merujuk ke dirinya sendiri atau ke definisi lain melalui $ref menjadi tipe bernama yang merujuk ke nama lainnya, yang dapat diselesaikan oleh TypeScript tanpa masalah.
Apakah alat ini memeriksa keabsahan schema saya?
Alat ini hanya membaca schema. Kata kunci yang tidak dikenal diabaikan dan schema tanpa type menjadi unknown. Gunakan JSON Schema Validator untuk memeriksa data terhadap schema.