Självstudie: Publicera flera versioner av ditt API
Det finns tillfällen när det är opraktiskt att alla anropare till ditt API använder exakt samma version. När anropare vill uppgradera till en senare version vill de ha en metod som är lätt att förstå. Som du ser i den här självstudien är det möjligt att tillhandahålla flera versioner i Azure API Management.
Bakgrundsinformation finns i Versioner & revisioner.
I den här guiden får du lära dig att:
- Lägga till en ny version till ett befintligt API
- Välja en version av ett schema
- Lägga till versionen till en produkt
- Gå till utvecklarportalen för att se versionen
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
- I Azure Portal navigerardu till din API Management instans.
- Välj API:er.
- Välj Demo Conference API från listan över API.
- Välj snabbmenyn (...) bredvid Demo Conference API.
- Välj Lägg till version.
Tips
Versioner kan också aktiveras när du skapar ett nytt API. På skärmen Lägg till API väljer du Version this API?.
Välja ett versionsschema
I Azure API Management du hur anropare anger API-versionen genom att välja ett versionsschema: sökväg, rubrik eller frågesträng. I följande exempel används sökvägen som versionsschema.
Ange värdena från följande tabell. Välj sedan Skapa för att skapa din version.
| Inställning | Värde | Beskrivning |
|---|---|---|
| Namn | demo-conference-api-v1 | Unikt namn i din API Management instans. Eftersom en version i själva verket är ett nytt API som baseras på en API-revisionär den här inställningen det nya API:ets namn. |
| Versionsschema | Sökväg | Hur anropare anger API-versionen. |
| Versionsidentifierare | v1 | Schemaspecifik indikator för versionen. För Sökväg, suffixet för API:ets URL-sökväg. Om Rubrik eller Frågesträng har valts anger du ytterligare ett värde: namnet på rubriken eller frågesträngsparametern. Ett användningsexempel visas. |
| Produkter | Obegränsat | Du kan också välja en eller flera produkter som API-versionen är associerad med. Om du vill publicera API:t måste du associera det med en produkt. Du kan också lägga till versionen i en produkt senare. |
När du har skapat versionen visas den under Demo Conference API i API-listan. Nu visas två API:er: Ursprungliga och v1.
Nu kan du redigera och konfigurera v1 som ett API som är separat från ursprunglig . Ändringar i de olika versionerna påverkar inte varandra.
Anteckning
Om du lägger till en version i ett API som inte är en version skapas även en ursprunglig version automatiskt. Den här versionen svarar på standard-URL:en. Genom att skapa en ursprunglig version säkerställer du att alla befintliga anropare inte bryts av processen med att lägga till en version. Om du skapar ett nytt API med versioner aktiverade i början skapas ingen ursprunglig version.
Lägga till versionen till en produkt
För att en anropare ska kunna se den nya versionen, måste den läggas till en produkt. Om du inte redan har lagt till versionen i en produkt kan du lägga till den i en produkt när som helst.
Om du till exempel vill lägga till versionen i produkten Obegränsat:
- I Azure Portal navigerar du till din API Management instans.
- Välj Products > Unlimited > API:er > + Lägg till.
- Välj Demo Conference API, version v1.
- Klicka på Välj.
Använda versionsuppsättningar
När du skapar flera versioner skapar Azure Portal en versionsuppsättning, som representerar en uppsättning versioner för ett enda logiskt API. Välj namnet på ett API som har flera versioner. Den Azure Portal visar versionsuppsättningen. Du kan anpassa namn och beskrivning för en virtuell uppsättning.
Du kan interagera direkt med versionsuppsättningar med hjälp av 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.
Om du vill se alla versionsuppsättningar kör du kommandot az apim api versionset list:
az apim api versionset list --resource-group apim-hello-word-resource-group \
--service-name apim-hello-world --output table
När Azure Portal skapar en versionsuppsättning åt dig tilldelar den ett alfanumeriskt namn som visas i kolumnen Namn i listan. Använd det här namnet i andra Azure CLI-kommandon.
Om du vill se information om en versionsuppsättning kör du kommandot az apim api versionset show:
az apim api versionset show --resource-group apim-hello-word-resource-group \
--service-name apim-hello-world --version-set-id 00000000000000000000000
Mer information om versionsuppsättningar finns i Versioner i Azure API Management.
Gå till utvecklarportalen för att se versionen
Om du har provat utvecklarportalen kandu se API-versioner där.
- Välj Utvecklarportal i den översta menyn.
- Välj API:er och sedan Demo Conference API.
- Du bör se en listrutan med flera versioner bredvid API-namnet.
- Välj v1.
- Observera Fråge-URL för den första åtgärden i listan. Det visar att URL-sökvägen för API:et innehåller v1.
Nästa steg
I den här självstudiekursen lärde du dig att:
- Lägga till en ny version till ett befintligt API
- Välja en version av ett schema
- Lägga till versionen till en produkt
- Gå till utvecklarportalen för att se versionen
Gå vidare till nästa kurs: