API ломается не в коде, а в контрактах: 6 проверок до интеграции

API ломается не в коде, а в контрактах: 6 проверок до интеграции

API удобно подключать, пока обе стороны одинаково понимают формат. На практике проблемы чаще всего появляются в контракте: поля приходят не в том типе, обязательность меняется, а ошибки описаны слишком общо.

Проверьте до интеграции:
— есть ли чёткая схема запросов и ответов;
— как ведут себя обязательные и опциональные поля;
— что приходит при пустых, неверных и лишних значениях;
— как устроены лимиты, таймауты и ретраи;
— одинаково ли API работает в dev, staging и production;
— можно ли воспроизвести ошибку без ручной переписки.

Отдельно смотрите на идемпотентность: повторный запрос не должен создавать дубль там, где действие уже выполнено. Для асинхронных сценариев полезно заранее понять, как отслеживать статус задачи и где искать причину сбоя.

Если контракт зафиксирован слабо, интеграция почти всегда съедает больше времени на разбор исключений, чем на сам код. В таких проектах спасает не скорость, а привычка проверять поведение API по краям, а не только по успешному сценарию.