Проектирование API-контрактов
Создаёт согласованные версионированные API-контракты из требований.
Обзор
Преобразуйте конкретный пользовательский сценарий в проверяемый API-контракт. Опишите успешные и ошибочные состояния, валидацию, пагинацию и обратную совместимость до реализации сервера.
Указанный источник
OpenAPI InitiativeСпецификация OpenAPInpx reporadars add api-contractCLI появится позже — только предварительный просмотр.
Черновик. Независимая проверка во время выполнения ожидается.
Источник указан; черновые инструкции оригинальны.
0.1.0, зафиксирована в этом черновике.
Явные разрешения и ограничения ниже.
Claude Code, Codex, Cursor
Читайте требования и создавайте черновики контрактов только по запросу. Без записи в живой API.
Возможности
- Сопоставлять действия пользователя со стабильными ресурсами
- Определять обязательные и необязательные поля
- Описывать единообразные ошибки валидации
- Описывать ожидания для пагинации и повторов
- Включать реалистичные примеры успеха и ошибки
- Проверять совместимость с существующими клиентами
Как это работает
- Уточните потребителей, сценарии и ограничения совместимости.
- Создайте минимальные формы запросов и ответов.
- Разберите валидацию, ошибки и повторы.
- Проверьте контракт инструментами проекта и зафиксируйте решения.
Это оригинальный черновик Reporadars, подготовленный с учётом указанного источника. Совместимость не проверялась независимо во время выполнения; перед использованием изучите инструкции, разрешения и размещение для своего агента.