Självstudie: Använda revisioner för att göra icke-api-ändringar på ett säkert sätt

Artikel
09/27/2021
4 minuter för att läsa

När ditt API är klart och börjar användas av utvecklare, måste du så småningom göra ändringar för det API:et och samtidigt se till att du inte stör anropen till API:et. Det är också bra att informera utvecklarna om de ändringar du gjort.

I Azure API Management du revisioner för att göra icke-icke-större API-ändringar så att du kan modellera och testa ändringar på ett säkert sätt. När du är klar kan du göra en revision aktuell och ersätta ditt aktuella API.

Bakgrundsinformation finns i Versioner & och API-versionshantering med Azure API Management.

I den här guiden får du lära dig att:

Lägga till en ny version
Göra bakåtkompatibla ändringar till din revision
Aktualisera dina revisioner och lägga till en ändringsloggpost
Gå till utvecklarportalen för att se dina ändringar och ändringsloggen

API-revisioner i Azure Portal

Förutsättningar

Lär dig Azure API Management-terminologin.
Slutför följande snabbstart: Skapa en Azure API Management instans.
Slutför även följande självstudie: Importera och publicera ditt första API.

Lägga till en ny version

Logga in på Azure Portaloch gå till din API Management instans.
Välj API:er.
Välj Demo Conference API (Demokonferens-API) i API-listan (eller ett annat API som du vill lägga till revisioner i).
Välj fliken Revisioner.
Välj + Lägg till revision.

Tips

Du kan också välja Lägg till revision på snabbmenyn (...) för API:et.
Ange en beskrivning för din nya revision så att du kommer ihåg vad den ska användas för.
Välj Skapa,
Nu skapas en ny version.

Anteckning

Det ursprungliga API:et ligger kvar i Revision 1. Det är den här revisionen dina användare fortsätter att anropa tills du väljer att aktualisera en annan revision aktuella.

Göra bakåtkompatibla ändringar till din revision

Välj Demo Conference API från listan över API.
Överst på skärmen väljer du fliken Design.
Observera att revisionsväljaren (direkt ovanför designfliken) Revision 2 som aktuellt val.

Tips

Använd revisionsväljaren för att växla mellan de revisioner du vill arbeta med.
Välj + Lägg till åtgärd.
Ange att den nya åtgärden ska vara POST, och ange Name (namn), Display Name (visningsnamn) och URL för åtgärden som test.
Spara den nya åtgärden.
Nu har du gjort en ändring i Revision 2. Använd revisionsväljaren längst upp på sidan för att växla tillbaka till Revision 1.
Observera att den nya åtgärden inte syns i Revision 1.

Aktualisera dina revisioner och lägga till en ändringsloggpost

Portal
Azure CLI

Välj fliken Revisioner från menyn upptill på sidan.
Öppna snabbmenyn (...) för revision 2.
Välj Gör aktuell.
Markera kryssrutan Post to Public Change log for this API (Publicera till offentlig ändringslogg för det här API:et) om du vill publicera anteckningar om den här ändringen. Ange en beskrivning för din ändring som utvecklare ser, till exempel: Testa revisioner. En ny teståtgärd har lagts till.
Nu är Revision 2 aktuell.

Så här börjar du använda Azure CLI:

Använd bash-miljön i Azure Cloud Shell.
Om du vill kan du i stället installera Azure CLI för att köra CLI-referenskommandon.
- Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Fler inloggningsalternativ finns i Logga in med Azure CLI.
- När du uppmanas till det installerar du Azure CLI-tillägg vid första användning. Mer information om tillägg finns i Använda tillägg med Azure CLI.
- Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.

Använd den här proceduren för att skapa och uppdatera en version.

Kör kommandot az apim api list för att se dina API-API-API:er:
```
az apim api list --resource-group apim-hello-word-resource-group \
    --service-name apim-hello-world --output table
```
Det API-ID som ska användas i nästa kommando är Name värdet. API-revisionen finns i ApiRevision kolumnen .

Kör kommandot az apim api release create för att skapa versionen med en version:

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.'

Den revision som du släpper blir den aktuella revisionen.

Om du vill se dina versioner använder du kommandot 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
```
Anteckningarna som du anger visas i ändringsloggen. Du kan se dem i utdata från föregående kommando.

När du skapar en version är --notes parametern valfri. Du kan lägga till eller ändra anteckningarna senare med hjälp av kommandot 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."

Använd värdet i kolumnen Name för publicerings-ID:t.

Du kan ta bort alla versioner genom att köra kommandot az apim api release delete:

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

Gå till utvecklarportalen för att se dina ändringar och ändringsloggen

Om du har provat utvecklarportalen kandu granska API-ändringarna och ändringsloggen där.

I den Azure Portal väljer du API:er.
Välj Utvecklarportalen på den översta menyn.
I utvecklarportalen väljer du API:er och sedan Demo Conference API.
Lägg märke till att din nya teståtgärd nu är tillgänglig.
Välj Ändringslogg nära API-namnet.
Observera att din post i ändringsloggen visas i den här listan.

Nästa steg

I den här självstudiekursen lärde du dig att:

Lägga till en ny version
Göra bakåtkompatibla ändringar till din revision
Aktualisera dina revisioner och lägga till en ändringsloggpost
Gå till utvecklarportalen för att se dina ändringar och ändringsloggen

Gå vidare till nästa kurs:

Publicera flera versioner av ditt API