Контракты ·
Спроектировать API-контракт
Согласовать ресурсы, методы, схемы данных и поведение интеграции до разработки.
Быстро понять за 2 минуты
Согласовать ресурсы, методы, схемы данных и поведение интеграции до разработки. Результат работы — OpenAPI Specification.
Контекст
Урок относится к этапу «Контракты». Зафиксировать границы взаимодействия систем и однозначные критерии приемки. Задачу выполняют до реализации или согласования зависимого решения, чтобы команда опиралась на проверенные факты и однозначные договоренности.
Что это дает
Правильно выполненная работа снижает стоимость переделок, делает решение проверяемым и дает участникам единый источник информации. Практический результат фиксируется в артефакте «OpenAPI Specification».
Как выполнить
- Опишите операции с точки зрения потребителя
- Зафиксируйте request и response schemas
- Добавьте примеры и ограничения полей
Критерии приемки
- Спецификация проходит lint
- Примеры соответствуют схемам
- Контракт согласован потребителями
Типичные ошибки
- Проектировать API по таблицам БД
- Оставлять optional поля без семантики
Инструменты
Рабочий артефакт
Рабочий артефакт
OpenAPI Specification
На рабочем проекте специалист начинает с шага «Опишите операции с точки зрения потребителя», фиксирует выводы в артефакте «OpenAPI Specification» и передает его владельцам решения. Пункт закрывается после проверки: «Спецификация проходит lint».
- Методы
- Ошибки
- Сценарии
- Версии
Контроль качества
Спецификация интеграции
Спецификация проходит lint
После релизов, изменения требований, обновления целей и появления новых рисков.
Контекст, проблему, доказательство, владельца, срок и критерий приемки.
Перед отметкой выполнено: Спецификация проходит lint
Как применять
Начинайте с влияния на пользователя, продукт и команду. Затем проверьте реализуемость, критерии качества и формат доказательства результата. Хороший пункт чеклиста объясняет, какую проблему закрываем, как выполняем работу и по каким признакам считаем ее завершенной.
Режим обучения
Тест по теме
Проверка понимания
Ответьте на вопросы по материалу и получите итоговый отчет: что понято хорошо, а что стоит перечитать.