OpenAPI у TypeScript
Створюйте типи TypeScript зі схем документа OpenAPI 3 або Swagger 2.0 у форматі YAML або JSON. Кожен запис у components.schemas або definitions у Swagger 2.0 стає експортованим інтерфейсом чи псевдонімом типу; зв’язки $ref стають назвами типів, а поля з підтримкою null отримують | null.
Поширені запитання
Які частини документа перетворюються?
Схеми в components.schemas для OpenAPI 3 і в definitions для Swagger 2.0. Шляхи, параметри й відповіді не перетворюються на типи; використовуйте створені типи схем у власному коді запитів і відповідей.
Як назви схем перетворюються на назви типів?
Кожен ключ схеми перетворюється на PascalCase: user-profile стає UserProfile. Якщо два ключі дають однакову назву, до другої додається число.
Чи підтримуються поля з підтримкою null?
Так. 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, який перелічує структурні проблеми й непрацюючі посилання. Цей конвертер читає лише схеми й не повідомляє про інші помилки.