openapi-ts/openapi-typescript

Что это?

Ключевые возможности

• 01Преобразует статические схемы OpenAPI 3 в определения типов TypeScript.
• 02Предоставляет openapi-fetch — fetch-клиент с типами, сгенерированными по схеме.
• 03Обнаруживает несовпадения между вызовами клиента и определениями API во время компиляции.
• 04Судя по темам проекта, поддерживает OpenAPI 3.1.

Сценарии использования

• Генерация типизированных моделей API-клиента для frontend-приложения по OpenAPI-файлу backend-сервиса.
• Создание типобезопасного fetch-клиента для существующего REST API.
• Поддержание соответствия типов клиента изменяющейся схеме API в CI.

Быстрый старт

1. 1

   Установите openapi-typescript из npm

   npm i -D openapi-typescript typescript
2. 2

   Сгенерируйте типы из схемы OpenAPI

   npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts

Темы

Частые вопросы

Что такое openapi-typescript?

Генерирует TypeScript-типы по схемам OpenAPI 3 и предоставляет типобезопасный fetch-клиент на их основе. openapi-typescript — монорепозиторий с двумя пакетами для работы со схемами OpenAPI в TypeScript. Основной пакет, openapi-typescript, преобразует статическую схему OpenAPI 3 в определения типов TypeScript, чтобы пути запросов, параметры и тела ответов проверялись во время компиляции, а не описывались вручную.

openapi-typescript можно использовать бесплатно? Какая у него лицензия?

openapi-typescript распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

openapi-typescript всё ещё поддерживается?

Обновлялся за последние 6 месяцев. Последний коммит в openapi-typescript — 25 сент. 2026 г..

Для чего можно использовать openapi-typescript?

Генерация типизированных моделей API-клиента для frontend-приложения по OpenAPI-файлу backend-сервиса. Создание типобезопасного fetch-клиента для существующего REST API. Поддержание соответствия типов клиента изменяющейся схеме API в CI.

Как установить openapi-typescript?

Установите openapi-typescript из npm: npm i -D openapi-typescript typescript Сгенерируйте типы из схемы OpenAPI: npx openapi-typescript https://petstore3.swagger.io/api/v3/openapi.json -o ./petstore.d.ts

Где скачать openapi-typescript?

Исходный код и инструкции по установке — на GitHub: https://github.com/openapi-ts/openapi-typescript