Чому стратегія версіонування API важлива

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Вступ до версіонування API

Вступ до версіонування

Аналогія з версіонуванням

Використовується, коли руйнівні зміни збентежать пасажирів
Поки будують нову лінію, пасажири користуються старою
Ревізії — це як обслуговування тієї самої лінії
- Підправлення колій, додавання навігації, згладжування поїздки
В APIM:
- Версії живуть у наборі версій
- Ревізії дають змогу редагувати, тестувати й позначати одну як поточну

Підтримуються три способи позначення версій:
- Версію можна вказати в шляху URL
- Версію можна вказати в заголовку запиту
- Версію можна вказати в рядку запиту URL
Стратегія версіонування має бути послідовною

Версіонування в шляху URL

Версіонування в заголовку

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

Версія проти ревізії

Canary-реліз

Результати:
- Якщо відгуки позитивні -> позначте ревізію як поточну
- Негативні -> відкотіть до попередньої ревізії

Наче пробний запуск на кухні: спершу подайте новий рецепт кільком столикам
В APIM:
- Створіть нову ревізію й протестуйте її приватно
- Відкрийте її для обмеженої аудиторії (пілотний продукт або частина клієнтів)
- Націлюйтеся на конкретну ревізію через спеціальний URL з номером ревізії
Залізнична метафора: тестувальники їдуть «службовою колією», не впливаючи на основну лінію

Керування API

Azure API Management