# 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: он перечисляет структурные проблемы и неработающие ссылки. Этот конвертер читает только схемы и не сообщает о других ошибках.

Ваша реклама здесь?

[Напишите нам по электронной почте](mailto:hi@dennn.is?subject=%D0%A0%D0%B5%D0%BA%D0%BB%D0%B0%D0%BC%D0%B0%20%D0%BD%D0%B0%20OneClick%20Pro)

[Реклама 433 инструментов для ваших ИИ-агентов через один MCP-сервер.](https://multitaskai.com/ru/?ref=oneclickpro)
