Спецификация OpenAPI — это стандартный формат для описания HTTP API, позволяющий читать его не только людям, но и инструментам. В одном документе перечислены все пути и методы, параметры, которые принимает каждый из них, тела запроса и ответа в формате JSON Schema, коды состояния и схемы аутентификации. Первоначальное название — Swagger; текущая основная версия — OpenAPI 3.1.
Из одного документа инструменты генерируют интерактивные справочные документы, клиентские SDK на многих языках, серверные заглушки, фиктивные серверы и контрактные тесты. Один и тот же файл можно проверить в CI на соответствие работающему API, поэтому описание и реализация не будут расходиться без сбоя сборки.
Доказательство того, что файл OpenAPI подтверждает корректное поведение API, — это утверждение, а не тест: ничто не мешает обработчику вернуть поле, которое никогда не упоминается в спецификации, или статус, который никогда не указывается. Ценность этого доказательства заключается в проверке на соответствие реальным ответам, что и является целью контрактного тестирования.
Для каждого API здесь публикуется собственный документ OpenAPI 3.1 по адресу /docs/{api-id}/openapi.json , а /openapi.json охватывает весь каталог; оба документа генерируются на основе тех же определений, что и страницы документации.
Все термины · Приёмы тестирования · Все 39 mock REST API
Последнее обновление