JSON Schema do TypeScript
Preveďte schému JSON na typy TypeScript. Objekty sa zmenia na rozhrania s povinnými a voliteľnými vlastnosťami, $defs a definície sa stanú pomenovanými exportmi, na ktoré odkazuje $ref. enum a const sa zmenia na literálové typy, anyOf a oneOf na zjednotenia a allOf na prienik. Opisy sa zachovajú ako komentáre kódu.
Často kladené otázky
Ktoré verzie schém JSON sú podporované?
Konvertor spracúva kľúčové slová spoločné pre draft-07, 2019-09 a 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf a $ref až $defs alebo definitions. Validačné kľúčové slová, ako minLength či pattern, nemajú ekvivalent TypeScript, preto sa vynechajú.
Ako sa riešia odkazy $ref?
Odkazy na #, #/$defs/Name a #/definitions/Name sa zmenia na pomenovaný typ príslušnej definície. Každý iný odkaz, napríklad na iný súbor alebo na URL, sa označí ako unknown a uvedie sa v komentári na začiatku výstupu.
Ako sa spracúva additionalProperties?
Objekt bez vlastností so schémou additionalProperties sa zmení na Record<string, T>. Objekt s vlastnosťami a schémou additionalProperties sa zmení na rozhranie spojené s Record<string, T>. Hodnota additionalProperties false alebo chýbajúce kľúčové slovo nič nepridá, pretože typy objektov TypeScript už opisujú známe kľúče.
Čo robí nullable?
Kľúčové slovo OpenAPI 3.0 nullable: true a rozšírenie Swagger x-nullable pridávajú do typu | null. V samotnej schéme JSON Schema zapíšte type: ["string", "null"], čo sa zmení na string | null.
Podporuje rekurzívne schémy?
Áno. Definícia, ktorá odkazuje na seba alebo na inú definíciu cez $ref, sa zmení na pomenovaný typ odkazujúci na druhý názov, ktorý TypeScript bez problémov vyrieši.
Kontroluje sa, či je moja schéma platná?
Nástroj schému iba číta. Neznáme kľúčové slová ignoruje a schéma bez typu sa zmení na unknown. Pomocou JSON Schema Validator skontrolujte údaje podľa schémy.