SYSTEM ATLASЗагрузка материала

Контракт обратного вызова API

API Callback Contract

Описание запроса, который сервер отправит клиенту позже, включая адрес, аутентификацию, повторы и формат ошибок.

Простыми словами

Иногда сервер не отвечает окончательным результатом сразу, а позже сам вызывает адрес клиента. Контракт заранее описывает, какой запрос придёт, как проверить отправителя и что делать при ошибке или повторе.

Пример от @Vibeclakr

Пример при разработке

Например, для «Контракт обратного вызова API» назначают ответственного и добавляют тест или метрику, по которой видно реальный результат.

Это редакционный пример применения, а не часть определения или доказательство концепции.

Формальное определение

Описание запроса, который сервер отправит клиенту позже, включая адрес, аутентификацию, повторы и формат ошибок.

Механизм действия

Для «Контракт обратного вызова API» команда фиксирует область действия, владельца, проверяемый сигнал и поведение при нарушении условия.

Пример в работе

Нерабочий подход

Повторять термин «Контракт обратного вызова API», не объяснив, где он применяется, кто отвечает и по какому признаку видно результат.

Системный подход

Связать «Контракт обратного вызова API» с конкретным сценарием, автоматической или ручной проверкой и правилом пересмотра.

Ограничения

«Контракт обратного вызова API» решает ограниченную задачу и не заменяет проверку соседних рисков, исходных допущений и последствий для всей системы.

Источник

IETF, “RFC 9205: Building Protocols with HTTP”, 2022.

Первоисточник