JSON Schema în TypeScript
Convertiți o schemă JSON în tipuri TypeScript. Obiectele devin interfețe cu proprietăți obligatorii și opționale, $defs și definițiile devin exporturi cu nume, către care indică $ref; enum și const devin tipuri literale, anyOf și oneOf devin uniuni, iar allOf devine o intersecție. Descrierile sunt păstrate ca comentarii de documentare.
Întrebări frecvente
Ce drafturi de schemă JSON sunt acceptate?
Convertorul citește cuvintele-cheie comune pentru draft-07, 2019-09 și 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf și $ref către $defs sau definitions. Cuvintele-cheie de validare, precum minLength sau pattern, nu au echivalent TypeScript și sunt omise.
Cum sunt rezolvate referințele $ref?
Referințele la #, #/$defs/Name și #/definitions/Name devin tipul cu numele definiției respective. Orice altă referință, cum ar fi una către un alt fișier sau un URL, este tipizată ca unknown și menționată într-un comentariu la începutul rezultatului.
Cum este tratat additionalProperties?
Un obiect fără proprietăți și cu o schemă additionalProperties devine Record<string, T>. Un obiect cu proprietăți și cu o schemă additionalProperties devine interfața combinată cu Record<string, T>. Valoarea false pentru additionalProperties sau lipsa acestui cuvânt-cheie nu adaugă nimic, deoarece tipurile de obiect TypeScript descriu deja cheile cunoscute.
Ce face nullable?
Cuvântul-cheie nullable: true din OpenAPI 3.0 și extensia Swagger x-nullable adaugă | null la tip. În JSON Schema propriu-zisă, scrieți type: ["string", "null"], care devine string | null.
Sunt acceptate schemele recursive?
Da. O definiție care face referire la ea însăși sau la o altă definiție prin $ref devine un tip cu nume care se referă la celălalt nume, pe care TypeScript îl rezolvă fără probleme.
Verifică dacă schema mea este validă?
Instrumentul doar citește schema. Cuvintele-cheie necunoscute sunt ignorate, iar o schemă fără un tip devine unknown. Folosiți validatorul JSON Schema pentru a verifica datele în raport cu o schemă.