Термин · Бизнес- и системный аналитик

OpenAPI

Машиночитаемая спецификация HTTP API, операций и схем данных.

Что означает

Контракт можно валидировать, документировать и использовать для генерации клиентов.

Пример применения

Спецификация фиксирует POST /orders и схему ошибки 422.

Синонимы и варианты

Swagger

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

Что такое OpenAPI?

Машиночитаемая спецификация HTTP API, операций и схем данных.

Где применяется OpenAPI?

Контракт можно валидировать, документировать и использовать для генерации клиентов.

Как выглядит пример OpenAPI?

Спецификация фиксирует POST /orders и схему ошибки 422.

Связанные термины

Где встречается

В YAML- или JSON-описании HTTP API, генерации документации, mock-серверов и контрактных тестов.

Ошибки понимания

OpenAPI описывает HTTP API, но не доказывает соответствие реализации. Swagger — название семейства инструментов и исторической спецификации; эти названия не всегда взаимозаменяемы.

· Версия 2 · Обновлено

Независимая экспертная проверка не заявлена.

Что обновлено
  • — Обновлено: Ошибки понимания.
  • — Обновлено: Где встречается, Ошибки понимания.

Материал предназначен для обучения. Адаптируйте рекомендации к внутренним регламентам компании и условиям проекта.

Предложить исправление через контакты Ariol