API и интеграции · База
Описать API-контракт
Зафиксировать endpoints, параметры, схемы ответов, ошибки и авторизацию.
Быстро понять за 2 минуты
Зафиксировать endpoints, параметры, схемы ответов, ошибки и авторизацию.
Контекст
API должен быть предсказуемым для клиентов: с понятными ресурсами, статусами, ошибками, версиями и документацией.
Что это дает
API-контракт снижает трение между backend, frontend, QA и внешними интеграторами.
Как выполнить
- Опишите ресурсы и методы.
- Добавьте request/response schemas.
- Укажите status codes, ошибки и требования авторизации.
Критерии приемки
- OpenAPI или аналог опубликован.
- Контракт покрывает успешные и ошибочные ответы.
- Frontend и QA используют документацию.
Типичные ошибки
- Документировать только happy path.
- Не обновлять контракт после изменения кода.
- Смешивать внутренние и внешние поля.
Инструменты
Рабочий артефакт
API contract
Контракт API
Документация эндпоинтов, схем запросов и ответов, ошибок, авторизации и правил версионирования.
- Endpoints
- Status codes
- Error format
- Versioning
Контроль качества
Контракт API
OpenAPI или аналог опубликован.
После изменения контрактов, релизов, инцидентов, роста нагрузки и пересмотра архитектурных решений.
Контракт, ограничения, сценарии отказа, метрики, владельца сервиса и критерии готовности.
Перед отметкой выполнено: OpenAPI или аналог опубликован.
Как применять
Начинайте с границ ответственности и пользовательского сценария, который обслуживает система. Затем проверьте контракт, данные, отказоустойчивость, безопасность и наблюдаемость. Хороший backend-пункт фиксирует, что именно меняется, как это проверить и какие метрики покажут стабильность решения.
Режим обучения
Прочитайте материал, прослушайте аудио и проверьте понимание по коротким вопросам. Ответ раскрывается после попытки сформулировать его самостоятельно.