JSON skeem TypeScript-iks
Teisenda JSON skeem TypeScript tüüpideks. Objektidest saavad kohustuslike ja valikuliste atribuutidega liidesed, $defs ja definitsioonidest saavad nimelised ekspordid, millele $ref viitab. Enum ja const muutuvad literaaltüüpideks, anyOf ja oneOf ühendtüüpideks ning allOf lõikeks. Kirjeldused säilitatakse dokumentatsioonikommentaaridena.
Korduma kippuvad küsimused
Milliseid JSON skeemidrafte toetatakse?
Teisendi loeb märksõnu, mida jagavad draft-07, 2019-09 ja 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf ja $ref kuni $defs või definitions. Valideerimise märksõnadel, näiteks minLength või pattern, pole TypeScript vastet ja need jäetakse välja.
Kuidas lahendatakse $ref viited?
Viidetest aadressidele #, #/$defs/Name ja #/definitions/Name saab vastava definitsiooni nimeline tüüp. Kõik muud viited, näiteks teisele failile või URL-ile, saavad tüübiks unknown ning need loetletakse väljundi alguses kommentaaris.
Kuidas käsitletakse additionalProperties märksõna?
Objektist, millel pole atribuute ja millel on additionalProperties skeem, saab Record<string, T>. Atribuutide ja additionalProperties skeemiga objektist saab liides, mis on ühendatud tüübiga Record<string, T>. additionalProperties false või puuduva märksõna korral midagi ei lisata, sest TypeScript objektitüübid kirjeldavad teadaolevaid võtmeid juba niigi.
Mida nullable teeb?
OpenAPI 3.0 nullable: true märksõna ja Swaggeri x-nullable laiendus lisavad tüübile | null. JSON skeemis kirjuta hoopis type: ["string", "null"], millest saab string | null.
Kas rekursiivseid skeeme toetatakse?
Jah. Definitsioonist, mis viitab iseendale või mõnele teisele definitsioonile $ref kaudu, saab nimeline tüüp, mis viitab teisele nimele. TypeScript lahendab selle probleemideta.
Kas see kontrollib, kas mu skeem on kehtiv?
See loeb ainult skeemi. Tundmatuid märksõnu eiratakse ja tüübita skeemist saab unknown. Andmete skeemi vastu kontrollimiseks kasuta JSON skeemivalidaatorit.