Почему важна стратегия версионирования API

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Введение в версионирование API

Введение в версионирование

Аналогия с версионированием

Используется, когда критические изменения могут нарушить работу клиентов
Пока строится новая ветка, пассажиры продолжают ехать по старой
Ревизии — как плановое обслуживание на том же маршруте
- Ремонт путей, обновление указателей, улучшение комфорта
В APIM:
- Версии хранятся внутри набора версий
- Ревизии позволяют редактировать, тестировать и отмечать одну как текущую

Поддерживаются три стратегии указания версии:
- Версия задаётся в пути URL
- Версия передаётся в заголовке запроса
- Версия указывается в строке запроса URL
Стратегия версионирования должна быть единообразной

Версионирование через путь URL

Версионирование через заголовок

Версионирование через строку запроса

Канареечный релиз

Результаты:
- Если отзывы хорошие -> отметить ревизию как текущую
- Плохие -> откатиться к предыдущей ревизии

Как тест нового блюда: сначала подаём нескольким столикам
В APIM:
- Создайте новую ревизию и протестируйте её в закрытом режиме
- Откройте ограниченной аудитории (пилотный продукт или часть клиентов)
- Обращайтесь к конкретной ревизии через специальный URL с её номером
Метафора с железной дорогой: тестировщики едут по «служебному пути», не затрагивая основной маршрут

API Management

Azure API Management