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

Версионирование API через media type

API Media-Type Versioning

Различение поколений представления ресурса через тип содержимого и параметры media type.

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

Версию ответа можно передавать не в адресе, а в типе содержимого. Тогда один URL остаётся тем же, а клиент и сервер договариваются, представление какого поколения они используют.

Пример от @Vibeclakr

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

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

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

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

Различение поколений представления ресурса через тип содержимого и параметры media type.

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

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

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

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

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

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

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

Ограничения

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

Источник

IETF, “RFC 9110: HTTP Semantics”, 2022.

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