Dela via

Revisioner i Azure API Management

  • Artikel

GÄLLER FÖR: Alla API Management-nivåer

Revisioner gör att du kan göra ändringar i dina API:er på ett kontrollerat och säkert sätt. När du vill göra ändringar skapar du en ny revision. Du kan sedan redigera och testa API utan att störa dina API-konsumenter. När du är klar gör du revisionen aktuell. Samtidigt kan du om du vill publicera en post i ändringsloggen för att hålla dina API-konsumenter uppdaterade med vad som har ändrats. Ändringsloggen publiceras på utvecklarportalen.

Kommentar

Utvecklarportalen är inte tillgänglig på förbrukningsnivån.

Med revisioner kan du:

  • Valv göra ändringar i api-definitioner och principer utan att störa ditt produktions-API.
  • Prova ändringar innan du publicerar dem.
  • Dokumentera de ändringar du gör, så att utvecklarna kan förstå vad som är nytt.
  • Återställ om du hittar problem.

Kom igång med revisioner genom att följa vår genomgång.

Åtkomst till specifika revisioner

Varje revision av API:et kan nås med hjälp av en särskilt utformad URL. ;rev={revisionNumber} Lägg till i slutet av API-URL:en, men innan frågesträngen, för att få åtkomst till en specifik revision av api:et. Du kan till exempel använda den här URL:en för att få åtkomst till revision 3 av API:et customers :

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

Som standard har varje revision samma säkerhetsinställningar som den aktuella revisionen. Du kan avsiktligt ändra principerna för en specifik revision om du vill att olika säkerhet ska tillämpas för varje revision. Du kanske till exempel vill lägga till en IP-filtreringsprincip för att förhindra externa anropare från att komma åt en revision som fortfarande är under utveckling.

Kommentar

;rev={id} Måste läggas till i API-ID:t och inte URI-sökvägen.

Aktuell revision

En enskild revision kan anges som den aktuella revisionen. Den här revisionen är den som används för alla API-begäranden som inte anger ett explicit revisionsnummer i URL:en. Du kan återställa till en tidigare revision genom att ange revisionen som aktuell.

Du kan ange en revision som aktuell med hjälp av Azure-portalen. Om du använder PowerShell kan du använda cmdleten New-AzApiManagementApiRelease .

Revisionsbeskrivningar

När du skapar en revision kan du ange en beskrivning för dina egna spårningsändamål. Beskrivningar visas inte för DINA API-användare.

När du anger en revision som aktuell kan du också ange en offentlig ändringslogganteckning. Ändringsloggen ingår i utvecklarportalen så att dina API-användare kan visa den. Du kan ändra ändringslogganteckningen med hjälp av PowerShell-cmdleten Update-AzApiManagementApiRelease .

Varning

Om du redigerar en icke-aktuell revision av ett API kan du inte ändra följande egenskaper:

  • Namn
  • Type
  • Description
  • Prenumeration som krävs
  • API-version
  • Beskrivning av API-version
  • Sökväg
  • Protokoll

Dessa egenskaper kan bara ändras i den aktuella revisionen. Om dina ändringar ändrar någon av ovanstående egenskaper för en icke-aktuell revision visas felmeddelandet Can't change property for non-current revision .

Ta en revision offline

En revision kan tas offline, vilket gör den otillgänglig för anropare även om de försöker komma åt revisionen via dess URL. Du kan markera en revision som offline med hjälp av Azure-portalen.

Kommentar

Vi rekommenderar att du tar revisioner offline när du inte använder dem för testning.

Versioner och revisioner

Versioner och revisioner är distinkta funktioner. Varje version kan ha flera revisioner, precis som ett icke-versions-API. Du kan använda revisioner utan att använda versioner eller tvärtom. Vanligtvis används versioner för att separera API-versioner med icke-bakåtkompatibla ändringar, medan revisioner kan användas för mindre och icke-icke-bakåtkompatibla ändringar i ett API.

Om du upptäcker att revisionen har icke-bakåtkompatibla ändringar, eller om du formellt vill omvandla revisionen till en beta-/testversion, kan du skapa en version från en revision. I Azure-portalen klickar du på "Skapa version från revision" på snabbmenyn revision på fliken Revisioner.