Заголовки «Устаревание» и «Завершение работы»

Устаревшая информация сообщает клиенту, что вызванная им конечная точка устарела — она по-прежнему работает, но больше не должна использоваться. Завершение работы указывает дату, после которой она может перестать отвечать. Вместе с заголовком Link, указывающим на замену, они позволяют API объявить о прекращении поддержки внутри самого трафика, где это может заметить клиентский код.

Как это работает

Клиенты и шлюзы могут регистрировать события или выдавать оповещения при появлении любого из этих заголовков, чтобы команда узнала о зависимости от выводимой из эксплуатации конечной точки, пока еще есть время. Заголовок Sunset содержит дату HTTP. Заголовок Link с rel="successor-version" или rel="deprecation" указывает на замену или на документацию по миграции.

Заблуждение

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

Попробуйте здесь.

GET /friends/v1/characters отвечает с заголовками Deprecation, Sunset и Link, указывающими на конечную точку v2; проверьте их в редакторе Expectations, подтвердив наличие заголовка headers.deprecation.

Источники

Другие термины

Читать страницу на английском

Все термины · Приёмы тестирования · Все 39 mock REST API

Последнее обновление