JSON Schema към TypeScript
Преобразувайте JSON Schema в типове TypeScript. Обектите стават интерфейси със задължителни и незадължителни свойства, $defs и definitions стават именувани експорти, към които сочи $ref; enum и const стават литерални типове, anyOf и oneOf стават обединения, а allOf — сечение. Описанията се запазват като коментари в документацията.
Често задавани въпроси
Кои чернови на схема за JSON се поддържат?
Конверторът прочита ключовите думи, общи за draft-07, 2019-09 и 2020-12: type, properties, required, additionalProperties, items, prefixItems, enum, const, anyOf, oneOf, allOf и $ref към $defs или definitions. Ключовите думи за валидация като minLength или pattern нямат еквивалент в TypeScript и се пропускат.
Как се разрешават препратките $ref?
Препратките към #, #/$defs/Name и #/definitions/Name стават именувания тип на съответната дефиниция. Всяка друга препратка, например към друг файл или към URL, се типизира като unknown и се посочва в коментар в началото на резултата.
Как се обработва additionalProperties?
Обект без свойства и със схема за additionalProperties става Record<string, T>. Обект със свойства и със схема за additionalProperties става интерфейс, обединен с Record<string, T>. additionalProperties false или липсваща ключова дума не добавя нищо, защото типовете обекти в TypeScript вече описват познатите ключове.
Какво прави nullable?
Ключовата дума nullable: true в OpenAPI 3.0 и разширението x-nullable в Swagger добавят | null към типа. В самия JSON Schema запишете type: ["string", "null"], което става string | null.
Поддържат ли се рекурсивни схеми?
Да. Дефиниция, която препраща към себе си или към друга дефиниция чрез $ref, става именуван тип, който препраща към другото име; TypeScript го разрешава без проблеми.
Проверява ли се дали схемата ми е валидна?
Инструментът само прочита схемата. Непознатите ключови думи се игнорират, а схема без type става unknown. Използвайте JSON Schema Validator, за да проверите данни спрямо схема.