Логотип

OpenAPI

Технологии и инженерия

Определение

OpenAPI — стандартный формат, в котором описывают API: какие запросы система принимает, какие поля в них должны быть и что она отвечает. Описание хранят в одном файле и из него автоматически получают документацию для разработчиков, тестовые заглушки и готовый код для подключения. Для бизнеса это значит, что команды фронтенда, бэкенда и внешний партнер работают по одному документу и меньше спорят о том, кто неправильно понял формат. Когда описание готово до кода, фронтенд и бэкенд можно делать параллельно. Раньше этот формат назывался Swagger, и так до сих пор называют инструменты для просмотра такой документации.