Waarom een API-versiestrategie belangrijk is

Azure API Management

Fiodar Sazanavets

Senior Software Engineer at Microsoft

Introductie tot API-versiebeheer

Intro versiebeheer

Azure API Management

Basis van API-versiebeheer

Versie-analogie

  • Gebruikt wanneer breaking changes reizigers zouden verwarren

  • Terwijl de nieuwe lijn wordt gebouwd, blijft men de oude gebruiken

  • Revisies zijn onderhoudsbeurten op dezelfde lijn

    • Rails herstellen, borden toevoegen, rit soepeler maken

  • In APIM:

    • Versies leven binnen een version set
    • Met revisies kun je bewerken, testen en er één als current markeren
Azure API Management

Versies aangeven

  • Drie manieren om versies aan te geven:
    • Versie in het URL-pad
    • Versie in de request-header
    • Versie in de URL-querystring
  • Kies één strategie en blijf consequent

Versie in URL-pad

Versie in header

Versie in querystring

Azure API Management

Versie vs. revisie

Versie vs. revisie

Azure API Management

Canary-releases

Canary-release

  • Uitkomsten:
    • Is feedback goed? -> markeer revisie als current
    • Slecht? -> rol terug naar de vorige revisie

  • Zoals in de keuken: serveer eerst een nieuw recept aan een paar tafels

  • In APIM:

    • Maak een nieuwe revisie en test die privé
    • Stel bloot aan een beperkte groep (pilotproduct of subset callers)
    • Richt op een specifieke revisie via een speciale URL met het revisienummer

  • Spoor-metafoor: testers rijden op het "onderhoudsspoor" zonder de hoofdlijn te storen

Azure API Management

Belangrijke concepten om te onthouden

  • Wanneer versies vs. revisies gebruiken
  • Versieschema configureren
  • Wijzigingen doorvoeren en terugdraaien

API-beheer

Azure API Management

Laten we oefenen!

Azure API Management

Preparing Video For Download...