Schéma JSON do TypeScript
Převeďte schéma JSON na typy TypeScript. Objekty se změní na rozhraní s povinnými a volitelnými vlastnostmi, $defs a definice se stanou pojmenovanými exporty, na které $ref odkazuje. enum a const se změní na literálové typy, anyOf a oneOf na sjednocení a allOf na průnik. Popisy se zachovají jako komentáře k dokumentaci.
Často kladené otázky
Které verze schématu JSON jsou podporovány?
Převodník čte klíčová slova společná pro draft-07, 2019-09 a 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf a $ref do $defs nebo definitions. Ověřovací klíčová slova, například minLength nebo pattern, nemají ekvivalent v TypeScript, a proto se vynechají.
Jak se řeší odkazy $ref?
Odkazy na #, #/$defs/Name a #/definitions/Name se změní na pojmenovaný typ příslušné definice. Jakýkoli jiný odkaz, například na jiný soubor nebo na URL, se označí jako unknown a uvede se v komentáři v horní části výstupu.
Jak se zpracovává additionalProperties?
Objekt bez vlastností a se schématem additionalProperties se změní na Record<string, T>. Objekt s vlastnostmi a se schématem additionalProperties se změní na rozhraní spojené s Record<string, T>. Hodnota additionalProperties false nebo chybějící klíč nic nepřidá, protože typy objektů v TypeScript už popisují známé klíče.
Jak funguje nullable?
Klíčové slovo OpenAPI 3.0 nullable: true a rozšíření Swagger x-nullable přidají k typu | null. V samotném schématu JSON zapište type: ["string", "null"], což se změní na string | null.
Jsou rekurzivní schémata podporována?
Ano. Definice, která odkazuje sama na sebe nebo na jinou definici prostřednictvím $ref, se změní na pojmenovaný typ odkazující na jiný název, který TypeScript bez problémů vyřeší.
Kontroluje nástroj, zda je moje schéma platné?
Nástroj schéma pouze čte. Neznámá klíčová slova ignoruje a schéma bez typu označí jako unknown. Data vůči schématu ověříte pomocí validátoru schématu JSON.