Zelfstudie: Revisies gebruiken om vaste API-wijzigingen veilig aan te brengen

Artikel
09/28/2021
4 minuten om te lezen

Wanneer uw API klaar is voor gebruik en daadwerkelijk wordt ingezet door ontwikkelaars, moet u op een bepaald moment wijzigingen aanbrengen aan die API, zonder dat dit gevolgen heeft voor clients die de API aanroepen. Het is ook handig om ontwikkelaars te informeren over de aangebrachte wijzigingen.

Gebruik in Azure API Management revisies om vaste API-wijzigingen aan te brengen, zodat u wijzigingen veilig kunt modelleren en testen. Wanneer u klaar bent, kunt u een revisie actueel maken en uw huidige API vervangen.

Zie Versies en revisies en API-versies met Azure API Management voor meer achtergrondinformatie.

In deze zelfstudie leert u het volgende:

Een nieuwe revisie toevoegen
Vaste wijzigingen aanbrengen in uw revisie
Uw revisie actualiseren en een logboekvermelding over de wijziging toevoegen
Door de portal voor ontwikkelaars browsen om de wijzigingen en het logboek in te zien

API-revisies in Azure Portal

Vereisten

Informatie over de terminologie van Azure API Management.
Voltooi de volgende snelstartgids: Een Azure API Management-exemplaar maken.
Voltooi ook de volgende zelfstudie: Uw eerste API importeren en publiceren.

Een nieuwe revisie toevoegen

Meld u aan bij Azure Portal en ga naar uw API Management-exemplaar.
Selecteer API's.
Selecteer Demo Conference API in de lijst met API's (of een andere API die u wilt wijzigen).
Selecteer het tabblad Revisies.
Selecteer + Revisie toevoegen.

Tip

U kunt ook Revisie toevoegen selecteren in het contextmenu ( ... ) van de API.
Geef een beschrijving voor de nieuwe revisie, om te onthouden waar deze voor wordt gebruikt.
Selecteer Maken.
Uw nieuwe revisie wordt nu gemaakt.

Notitie

Uw oorspronkelijke API blijft in Revisie 1. Dit is de revisie die uw gebruikers blijven aanroepen, totdat u ervoor kiest om een andere revisie de huidige te maken.

Vaste wijzigingen aanbrengen in uw revisie

Selecteer Demo Conference API in de lijst met API's.
Selecteer boven in het scherm het tabblad Ontwerp.
U ziet dat de revisieselector (direct boven het tabblad Ontwerp) Revisie 2 aangeeft als de huidige selectie.

Tip

Gebruik de revisieselector om te schakelen tussen de wijzigingen waaraan u wilt werken.
Klik op + Bewerking toevoegen.
Stel uw nieuwe bewerking in als POST, en de naam, weergavenaam en URL van de bewerking als test
Sla uw nieuwe bewerking op.
U hebt nu een wijziging aangebracht in Revisie 2. Gebruik de revisieselector bovenaan de pagina om over te schakelen naar Revisie 1.
Merk op dat uw nieuwe bewerking niet wordt weergegeven in Revisie 1.

Uw revisie actualiseren en een logboekvermelding over de wijziging toevoegen

Portal
Azure-CLI

Klik op het tabblad Revisies in het menu aan de bovenkant van de pagina.
Open het contextmenu ( ... ) voor Revisie 2.
Selecteer Instellen als huidige.
Schakel het selectievakje Op het openbare wijzigingenlogboek voor deze API plaatsen in als u opmerkingen over deze wijziging wilt plaatsen. Geef een beschrijving op voor de wijziging die aan ontwikkelaars wordt weergegeven, bijvoorbeeld: Revisies testen. Nieuwe 'test'-bewerking toegevoegd.
Revisie 2 is nu actueel.

Als u Azure CLI wilt gaan gebruiken, gaat u als volgende te werk:

Gebruik de bash-omgeving in Azure Cloud shell.
Installeer de Azure CLI, indien gewenst, om CLI-referentieopdrachten uit te voeren.
- Als u een lokale installatie gebruikt, meldt u zich aan bij Azure CLI met behulp van de opdracht AZ login. Volg de stappen die worden weergegeven in de terminal, om het verificatieproces te voltooien. Raadpleeg Aanmelden bij de Azure CLI voor aanvullende aanmeldingsopties.
- Installeer de Azure CLI-extensie bij het eerste gebruik, wanneer u hierom wordt gevraagd. Raadpleeg Extensies gebruiken met Azure CLI voor meer informatie over extensies.
- Voer az version uit om de geïnstalleerde versie en afhankelijke bibliotheken te vinden. Voer az upgrade uit om te upgraden naar de nieuwste versie.

Gebruik deze procedure om een release te maken en bij te werken.

Voer de opdracht az apim api list uit om uw API-ID's te zien:
```
az apim api list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table
```
De API-id die in de volgende opdracht moet worden gebruikt, is de Name waarde . De API-revisie staat in de ApiRevision kolom .

Voer de opdracht az apim api release create uit om de release te maken met een release-opmerking:

az apim api release create --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --api-revision 2 --service-name apim-hello-world \
    --notes 'Testing revisions. Added new "test" operation.'

De revisie die u vrijgave wordt de huidige revisie.

Als u uw releases wilt zien, gebruikt u de opdracht az apim api release list:
```
az apim api release list --resource-group apim-hello-word-resource-group \
    --api-id echo-api --service-name apim-hello-world --output table
```
De notities die u opgeeft, worden weergegeven in het wijzigingslogo. U kunt ze zien in de uitvoer van de vorige opdracht.

Wanneer u een release maakt, is --notes de parameter optioneel. U kunt de notities later toevoegen of wijzigen met behulp van de opdracht az apim api release update:

az apim api release update --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --release-id 00000000000000000000000000000000 \
    --service-name apim-hello-world --notes "Revised notes."

Gebruik de waarde in de Name kolom voor de release-id.

U kunt elke release verwijderen door de opdracht az apim api release delete uit te voeren:

az apim api release delete --resource-group apim-hello-word-resource-group \
    --api-id demo-conference-api --release-id 00000000000000000000000000000000 
    --service-name apim-hello-world

Door de portal voor ontwikkelaars browsen om de wijzigingen en het logboek in te zien

Als u de ontwikkelaarsportal hebt geprobeerd, kunt u de wijzigingen in de API en het wijzigingslogboek bekijken.

Selecteer API's in de Azure-portal.
Selecteer Ontwikkelaarsportal in het menu bovenaan.
Selecteer API's in de ontwikkelaarsportal en selecteer vervolgens Demo Conference API.
U ziet dat uw nieuwe test bewerking nu beschikbaar is.
Selecteer Changelog bij de naam van de API.
U ziet dat de vermelding van het wijzigingslogboek in deze lijst wordt weergegeven.

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

Een nieuwe revisie toevoegen
Vaste wijzigingen aanbrengen in uw revisie
Uw revisie actualiseren en een logboekvermelding over de wijziging toevoegen
Door de portal voor ontwikkelaars browsen om de wijzigingen en het logboek in te zien

Ga door naar de volgende zelfstudie:

Meerdere versies van uw API publiceren