OpenAPI към TypeScript
Генерирайте типове TypeScript от схемите в документ OpenAPI 3 или Swagger 2.0 във формат YAML или JSON. Всеки запис под components.schemas или definitions в Swagger 2.0 става експортиран интерфейс или псевдоним на тип; връзките $ref между тях стават имена на типове, а nullable полетата получават | null.
Често задавани въпроси
Кои части от документа се преобразуват?
Схемите под components.schemas в OpenAPI 3 и под definitions в Swagger 2.0. Пътищата, параметрите и отговорите не се преобразуват в типове; използвайте генерираните типове на схеми в собствения си код за заявки и отговори.
Как имената на схемите стават имена на типове?
Всеки ключ на схема се преобразува в PascalCase, така че user-profile става UserProfile. Когато два ключа биха получили едно и също име, към втория се добавя число.
Поддържат ли се nullable полета?
Да. nullable: true от OpenAPI 3.0 и x-nullable: true от Swagger 2.0 добавят | null, а масиви от типове в OpenAPI 3.1, като ["string", "null"], стават string | null.
Какво става с препратките, които инструментът не може да разреши?
$ref, която сочи извън документа или към нещо различно от схема в components.schemas или definitions, става unknown и се посочва в коментар в началото на резултата.
Поддържа ли се YAML?
Да. Поставете документа във формат YAML или JSON. Котвите и псевдонимите в YAML се разгръщат преди преобразуването.
Как да проверя документа предварително?
Използвайте OpenAPI Validator, който изброява структурните проблеми и невалидните препратки. Този конвертор прочита само схемите и не съобщава други грешки.