Revisies in Azure API Management

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

Met revisies kunt u uw API's op een gecontroleerde en veilige manier wijzigen. Als u wijzigingen wilt aanbrengen, maakt u een nieuwe revisie. Vervolgens kunt u de API bewerken en testen zonder uw API-gebruikers te storen. Wanneer u klaar bent, maakt u de revisie actueel. Tegelijkertijd kunt u desgewenst een vermelding in het wijzigingslogboek posten om uw API-gebruikers op de hoogte te houden van wat er is gewijzigd. Het wijzigingenlogboek wordt gepubliceerd naar uw ontwikkelaarsportal.

Notitie

De ontwikkelaarsportal is niet beschikbaar in de verbruikslaag.

Met revisies kunt u het volgende doen:

  • Breng veilig wijzigingen aan in uw API-definities en -beleid, zonder uw productie-API te storen.
  • Probeer wijzigingen uit voordat u ze publiceert.
  • Documenteer de wijzigingen die u aanbrengt, zodat uw ontwikkelaars kunnen begrijpen wat er nieuw is.
  • Terugdraaien als u problemen vindt.

Ga aan de slag met revisies door onze procedure te volgen.

Toegang tot specifieke revisies

Elke revisie van uw API kan worden geopend met behulp van een speciaal gevormde URL. Voeg ;rev={revisionNumber} aan het einde van uw API-URL toe, maar voordat de querytekenreeks toegang heeft tot een specifieke revisie van die API. U kunt deze URL bijvoorbeeld gebruiken voor toegang tot revisie 3 van de customers API:

https://apis.contoso.com/customers;rev=3/leads?customerId=123

Standaard heeft elke revisie dezelfde beveiligingsinstellingen als de huidige revisie. U kunt het beleid voor een specifieke revisie opzettelijk wijzigen als u voor elke revisie een andere beveiliging wilt toepassen. U kunt bijvoorbeeld een IP-filterbeleid toevoegen om te voorkomen dat externe bellers toegang hebben tot een revisie die nog in ontwikkeling is.

Notitie

De ;rev={id} id moet worden toegevoegd aan de API-id en niet aan het URI-pad.

Huidige revisie

Eén revisie kan worden ingesteld als de huidige revisie. Deze revisie wordt gebruikt voor alle API-aanvragen die geen expliciet revisienummer in de URL opgeven. U kunt teruggaan naar een vorige revisie door die revisie in te stellen als actueel.

U kunt een revisie instellen als actueel met behulp van Azure Portal. Als u PowerShell gebruikt, kunt u de New-AzApiManagementApiRelease cmdlet gebruiken.

Revisiebeschrijvingen

Wanneer u een revisie maakt, kunt u een beschrijving instellen voor uw eigen traceringsdoeleinden. Beschrijvingen worden niet weergegeven voor uw API-gebruikers.

Wanneer u een revisie instelt als actueel, kunt u desgewenst ook een openbare wijzigingslogboeknotitie opgeven. Het wijzigingslogboek is opgenomen in de ontwikkelaarsportal om uw API-gebruikers te bekijken. U kunt uw wijzigingslogboeknotitie wijzigen met behulp van de Update-AzApiManagementApiRelease PowerShell-cmdlet.

Let op

Als u een niet-actuele revisie van een API bewerkt, kunt u de volgende eigenschappen niet wijzigen:

  • Naam
  • Type
  • Beschrijving
  • Abonnement vereist
  • API-versie
  • Beschrijving van API-versie
  • Pad
  • Protocollen

Deze eigenschappen kunnen alleen worden gewijzigd in de huidige revisie. Als uw bewerkingen een van de bovenstaande eigenschappen van een niet-huidige revisie wijzigen, wordt het foutbericht Can't change property for non-current revision weergegeven.

Een revisie offline zetten

Een revisie kan offline worden gehaald, waardoor het niet toegankelijk is voor bellers, zelfs als ze de revisie proberen te openen via de URL. U kunt een revisie als offline markeren met behulp van Azure Portal.

Notitie

We raden u aan om revisies offline te zetten wanneer u ze niet gebruikt voor testen.

Versies en revisies

Versies en revisies zijn verschillende functies. Elke versie kan meerdere revisies hebben, net als een niet-geversiede API. U kunt revisies gebruiken zonder versies te gebruiken of andersom. Normaal gesproken worden versies gebruikt om API-versies te scheiden met belangrijke wijzigingen, terwijl revisies kunnen worden gebruikt voor kleine en niet-belangrijke wijzigingen in een API.

Als u merkt dat uw revisie wijzigingen bevat die fouten veroorzaken of als u de revisie formeel wilt omzetten in een bèta-/testversie, kunt u een versie maken op basis van een revisie. Klik in Azure Portal op 'Versie maken op basis van revisie' in het contextmenu revisie op het tabblad Revisies.