Proč je strategie verzování API důležitá

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Úvod do verzování API

Úvod do verzování

Azure API Management

Základy verzování API

Analogie verzování

  • Používá se, když by zásadní změny zmátly cestující

  • Zatímco se buduje nová linka, cestující používají stávající

  • Revize jsou jako údržba na stejné lince

    • Oprava kolejí, přidání značení, vyhlazení jízdy

  • V APIM:

    • Verze jsou součástí sady verzí
    • Revize umožňují upravovat, testovat a označit jednu jako aktuální
Azure API Management

Označování verzí

  • Jsou podporovány tři strategie označování verzí:
    • Verze může být uvedena v cestě URL
    • Verze může být specifikována v hlavičce požadavku
    • Verze může být specifikována v dotazovacím řetězci URL
  • Strategie verzování musí být konzistentní

Verzování v cestě URL

Verzování v hlavičce

Verzování v dotazovacím řetězci

Azure API Management

Verze vs. revize

Verze vs. revize

Azure API Management

Canary releases

Canary release

  • Výsledky:
    • Kladná zpětná vazba -> označit revizi jako aktuální
    • Záporná -> vrátit se k předchozí revizi

  • Jako test v kuchyni: nový recept nejprve podejte u několika stolů

  • V APIM:

    • Vytvořte novou revizi a otestujte ji interně
    • Zpřístupněte ji omezenému okruhu uživatelů (pilotní produkt nebo podmnožina volajících)
    • Cílení na konkrétní revizi přes speciální URL s číslem revize

  • Metafora železnice: testeři jezdí po „servisní trati" bez dopadu na hlavní linku

Azure API Management

Klíčové koncepty k zapamatování

  • Kdy použít verze vs. revize
  • Konfigurace schématu verzování
  • Posouvání změn vpřed a zpět

API Management

Azure API Management

Pojďme si procvičit!

Azure API Management

Preparing Video For Download...