OpenAPI-контракт
В контракте должны быть реальные методы, схемы, ошибки, доступ и примеры.
Проверено Изменено
Плохо
Новый endpoint работает, но в документации его нет.
Хорошо
Изменены обработчик, OpenAPI, пример и тест.
operationId уникален и стабилен.
Почему это важно
Клиенты и агенты не должны угадывать формат запроса.
Когда применять
OpenAPI 3.2 подходит при поддержке инструментов; 3.1 остаётся допустимым осознанным выбором. Разбиение по модулям зависит от размера API.
Кто что делает
Человек
Утверждает публичные поля и обязательства перед клиентами.
AI-агент
Реализует серверный контракт и проверяет успешный запрос, неверный ввод и повторное обращение.
Контроль результата:
- Сопоставьте реальные маршруты, операции контракта и каталог endpoints.
Как проверить у себя
- Сопоставьте реальные маршруты, операции контракта и каталог endpoints.
Первоисточники
История изменений на GitHubДата проверки отражает содержательную сверку. Синхронизация сайта не обновляет её автоматически.