Warum eine API-Versionierungsstrategie wichtig ist

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Einführung in die API-Versionierung

Einführung in die Versionierung

Azure API Management

Grundlagen der API-Versionierung

Versionierungs-Analogie

  • Wird genutzt, wenn Breaking Changes Fahrgäste verwirren würden

  • Während die neue Linie entsteht, nutzen Fahrgäste weiter die alte

  • Revisionen sind wie Wartung an derselben Linie

    • Gleise reparieren, Beschilderung ergänzen, Fahrt glätten

  • In APIM:

    • Versionen leben in einem Version Set
    • Revisionen erlauben Bearbeiten, Testen und eine als aktuell zu markieren
Azure API Management

Version kennzeichnen

  • Drei Strategien zum Kennzeichnen der Version werden unterstützt:
    • Version im URL-Pfad angeben
    • Version im Request-Header angeben
    • Version in der URL-Query angeben
  • Die Versionierungsstrategie muss konsistent sein

Versionierung im URL-Pfad

Header-Versionierung

Query-String-Versionierung

Azure API Management

Version vs. Revision

Version vs. Revision

Azure API Management

Canary Releases

Canary Release

  • Ergebnisse:
    • Ist das Feedback gut -> markiere die Revision als aktuell
    • Schlecht -> auf die vorherige Revision zurückrollen

  • Wie ein Küchentest: erst ein neues Rezept an wenige Tische servieren

  • In APIM:

    • Neue Revision erstellen und privat testen
    • Einer begrenzten Zielgruppe exponieren (Pilotprodukt oder Teilmenge der Aufrufer)
    • Eine bestimmte Revision über eine spezielle URL mit Revisionsnummer ansteuern

  • Bahnmetapher: Tester fahren auf der „Wartungsspur", ohne die Hauptlinie zu stören

Azure API Management

Wichtige Konzepte zum Merken

  • Wann Versionen vs. Revisionen nutzen
  • Versionsschema konfigurieren
  • Änderungen vor- und zurückrollen

API-Verwaltung

Azure API Management

Lass uns üben!

Azure API Management

Preparing Video For Download...