De ce contează strategia de versionare a API

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Introducere în versionarea API

Introducere în versionare

Azure API Management

Fundamentele versionării API

Analogie versionare

  • Utilizată când modificările incompatibile ar crea confuzie

  • Cât timp linia nouă se construiește, pasagerii folosesc în continuare cea veche

  • Reviziile sunt ca întreținerea periodică a aceleiași linii

    • Repararea șinelor, adăugarea de indicatoare, îmbunătățirea mersului

  • În APIM:

    • Versiunile sunt grupate într-un set de versiuni
    • Reviziile permit editarea, testarea și marcarea uneia ca actuală
Azure API Management

Indicarea versiunii

  • Sunt suportate trei strategii de indicare a versiunii:
    • Versiunea poate fi declarată în calea URL
    • Versiunea poate fi specificată în antetul cererii
    • Versiunea poate fi specificată în șirul de interogare URL
  • Strategia de versionare trebuie să fie consecventă

Versionare prin calea URL

Versionare prin antet

Versionare prin șir de interogare

Azure API Management

Versiune vs. revizie

Versiune vs. revizie

Azure API Management

Lansări canary

Lansare canary

  • Rezultate:
    • Feedback pozitiv -> marcați revizia ca actuală
    • Feedback negativ -> revenire la revizia anterioară

  • Ca un test în bucătărie: serviți rețeta nouă la câteva mese mai întâi

  • În APIM:

    • Creați o revizie nouă și testați-o privat
    • Expuneți-o unui public limitat (produs pilot sau subset de apelanți)
    • Vizați o revizie specifică printr-un URL special cu numărul reviziei

  • Metafora feroviară: testerii călătoresc pe „linia de mentenanță" fără a afecta linia principală

Azure API Management

Concepte cheie de reținut

  • Când se folosesc versiuni vs. revizii
  • Configurarea schemei de versionare
  • Aplicarea și revenirea modificărilor

API Management

Azure API Management

Să exersăm!

Azure API Management

Preparing Video For Download...