Dlaczego strategia wersjonowania API jest ważna

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Wprowadzenie do wersjonowania API

Wprowadzenie do wersjonowania

Azure API Management

Podstawy wersjonowania API

Analogia wersjonowania

  • Stosowane, gdy przełomowe zmiany mogłyby dezorientować użytkowników

  • Podczas budowy nowej linii pasażerowie korzystają ze starej

  • Rewizje to jak konserwacja tej samej linii

    • Naprawa torów, dodawanie oznaczeń, poprawa komfortu jazdy

  • W APIM:

    • Wersje są przechowywane w zestawie wersji
    • Rewizje umożliwiają edycję, testowanie i oznaczenie jednej jako bieżąca
Azure API Management

Oznaczanie wersji

  • Obsługiwane są trzy strategie oznaczania wersji:
    • Wersja może być podana w ścieżce URL
    • Wersja może być podana w nagłówku żądania
    • Wersja może być podana w ciągu zapytania URL
  • Strategia wersjonowania musi być spójna

Wersjonowanie w ścieżce URL

Wersjonowanie w nagłówku

Wersjonowanie w ciągu zapytania

Azure API Management

Wersja a rewizja

Wersja a rewizja

Azure API Management

Wdrożenia kanaryjskie

Wdrożenie kanaryjskie

  • Wyniki:
    • Pozytywna opinia -> oznacz wersję jako bieżącą
    • Negatywna -> przywróć poprzednią wersję

  • Jak test w kuchni: najpierw podaj nowe danie kilku stolikow

  • W APIM:

    • Utwórz nową wersję i przetestuj ją prywatnie
    • Udostępnij ją ograniczonej grupie (pilot lub podzbiór wywołań)
    • Wskaż konkretną wersję przez specjalny adres URL z numerem wersji

  • Metafora kolejowa: testerzy jadą "torem serwisowym" bez wpływu na główną linię

Azure API Management

Kluczowe pojęcia do zapamiętania

  • Kiedy używać wersji, a kiedy rewizji
  • Konfigurowanie schematu wersjonowania
  • Wdrażanie i cofanie zmian

API Management

Azure API Management

Czas na ćwiczenia!

Azure API Management

Preparing Video For Download...