Термин · Бизнес- и системный аналитик
API contract
Соглашение о формате и поведении интерфейса между системами.
Что означает
Контракт включает данные, ошибки, версии и правила совместимости.
Пример применения
Клиент знает, когда API возвращает 409 и можно ли повторить запрос.
Синонимы и варианты
Частые вопросы
Что такое API contract?
Соглашение о формате и поведении интерфейса между системами.
Где применяется API contract?
Контракт включает данные, ошибки, версии и правила совместимости.
Как выглядит пример API contract?
Клиент знает, когда API возвращает 409 и можно ли повторить запрос.
Связанные термины
Где встречается
В проектировании взаимодействия компонентов и описании данных, операций и границ ответственности. Примеры запросов связывают с проверяемым контрактом.
Ошибки понимания
Контракт охватывает не только успешный JSON-ответ: обязательность полей, ошибки, права и совместимость тоже должны быть согласованы. Код одной стороны не заменяет договор между сторонами.
Редакция Ariol · Версия 2 · Обновлено
Независимая экспертная проверка не заявлена.
Что обновлено
- — Обновлено: Где встречается, Ошибки понимания.
Материал предназначен для обучения. Адаптируйте рекомендации к внутренним регламентам компании и условиям проекта.
Предложить исправление через контакты Ariol