JSON Schema į TypeScript
Konvertuoja JSON schemą į TypeScript tipus. Objektai tampa sąsajomis su privalomomis ir neprivalomomis savybėmis, $defs ir apibrėžtys – pavadintais eksportais, į kuriuos nurodo $ref, enum ir const tampa literalų tipais, anyOf ir oneOf – sąjungomis, o allOf – sankirta. Aprašymai išsaugomi kaip dokumentacijos komentarai.
Dažnai užduodami klausimai
Kurios JSON schemos versijos palaikomos?
Konverteris nuskaito draft-07, 2019-09 ir 2020-12 bendrus raktažodžius: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf ir $ref į $defs arba definitions. Tikrinimo raktažodžiai, pavyzdžiui, minLength ar pattern, neturi atitikmens TypeScript ir praleidžiami.
Kaip sprendžiamos $ref nuorodos?
Nuorodos į #, #/$defs/Name ir #/definitions/Name tampa atitinkamos apibrėžties pavadintu tipu. Visos kitos nuorodos, pavyzdžiui, į kitą failą ar URL, tipizuojamos kaip unknown ir išvardijamos komentare išvesties viršuje.
Kaip apdorojama additionalProperties?
Objektas be savybių, bet su additionalProperties schema, tampa Record<string, T>. Objektas su savybėmis ir additionalProperties schema tampa sąsaja, sujungta su Record<string, T>. additionalProperties false arba trūkstamas raktažodis nieko neprideda, nes TypeScript objektų tipai jau aprašo žinomus raktus.
Ką daro nullable?
OpenAPI 3.0 raktažodis nullable: true ir Swagger x-nullable plėtinys prie tipo prideda | null. Pačioje JSON schemoje įrašykite type: ["string", "null"], kuris tampa string | null.
Ar palaikomos rekursinės schemos?
Taip. Apibrėžtis, nurodanti į save arba kitą apibrėžtį per $ref, tampa pavadintu tipu, nurodančiu į kitą pavadinimą, kurį TypeScript išsprendžia be problemų.
Ar tikrinama, ar mano schema galiojanti?
Įrankis tik nuskaito schemą. Nežinomi raktažodžiai ignoruojami, o schema be tipo tampa unknown. Duomenims pagal schemą tikrinti naudokite JSON Schema Validator.