Контракты ·
Описать ошибки и идемпотентность API
Сделать поведение интеграции предсказуемым при валидации, повторах и частичных сбоях.
Быстро понять за 2 минуты
Сделать поведение интеграции предсказуемым при валидации, повторах и частичных сбоях. Результат работы — Error Catalog.
Контекст
Урок относится к этапу «Контракты». Зафиксировать границы взаимодействия систем и однозначные критерии приемки. Задачу выполняют до реализации или согласования зависимого решения, чтобы команда опиралась на проверенные факты и однозначные договоренности.
Что это дает
Правильно выполненная работа снижает стоимость переделок, делает решение проверяемым и дает участникам единый источник информации. Практический результат фиксируется в артефакте «Error Catalog».
Как выполнить
- Классифицируйте бизнес- и технические ошибки
- Опишите код, сообщение и recoverability
- Зафиксируйте retry и idempotency policy
Критерии приемки
- Коды стабильны и документированы
- Клиент понимает следующее действие
- Повтор запроса безопасен там, где требуется
Типичные ошибки
- Возвращать одну ошибку на все случаи
- Использовать текст сообщения как контракт
Инструменты
Рабочий артефакт
Рабочий артефакт
Error Catalog
На рабочем проекте специалист начинает с шага «Классифицируйте бизнес- и технические ошибки», фиксирует выводы в артефакте «Error Catalog» и передает его владельцам решения. Пункт закрывается после проверки: «Коды стабильны и документированы».
- Методы
- Ошибки
- Сценарии
- Версии
Контроль качества
Спецификация интеграции
Коды стабильны и документированы
После релизов, изменения требований, обновления целей и появления новых рисков.
Контекст, проблему, доказательство, владельца, срок и критерий приемки.
Перед отметкой выполнено: Коды стабильны и документированы
Как применять
Начинайте с влияния на пользователя, продукт и команду. Затем проверьте реализуемость, критерии качества и формат доказательства результата. Хороший пункт чеклиста объясняет, какую проблему закрываем, как выполняем работу и по каким признакам считаем ее завершенной.
Режим обучения
Тест по теме
Проверка понимания
Ответьте на вопросы по материалу и получите итоговый отчет: что понято хорошо, а что стоит перечитать.