Självstudie: Använda API Management för att Visual Studio kod för att importera och hantera API:er

I den här självstudien lär du dig att använda API Management-tillägget för Visual Studio Code för vanliga åtgärder i API Management. Använd den välbekanta Visual Studio Code-miljön för att importera, uppdatera, testa och hantera API:er.

Lär dig att:

En introduktion till ytterligare funktioner API Management finns i API Management självstudier med hjälp av Azure Portal.

Förutsättningar

• Förstå terminologin API Management Azure-tjänster
• Kontrollera att du har Visual Studio Code och det senaste Azure API Management-tillägget för Visual Studio Code
• Skapa en API Management instans

Importera ett API

I följande exempel importeras en OpenAPI-specifikation i JSON-format till API Management. Microsoft tillhandahåller server-API:et som används i det här exemplet och är värd för det på Azure på https://conferenceapi.azurewebsites.net?format=json .

1. I Visual Studio Code väljer du Azure-ikonen i Aktivitetsfältet.
2. I Explorer-fönstret expanderar du den API Management som du skapade.
3. Högerklicka på API:er och välj Importera från OpenAPI Link.
4. Ange följande värden när du uppmanas till det:
   1. En OpenAPI-länk för innehåll i JSON-format. I det här exemplet: https://conferenceapi.azurewebsites.net?format=json . Den här URL:en är den tjänst som implementerar exempel-API:et. API Management vidarebefordrar begäranden till den här adressen.
   2. Ett API-namn, till exempel demo-conference-api, som är unikt i API Management instansen. Det här namnet får bara innehålla bokstäver, siffror och bindestreck. Det första och sista tecknen måste vara alfanumeriska. Det här namnet används i sökvägen för att anropa API:et.

När API:et har importerats visas det i Explorer-fönstret och tillgängliga API-åtgärder visas under noden Åtgärder.

Redigera API:et

Du kan redigera API:et i Visual Studio Code. Du kan till exempel redigera Resource Manager JSON-beskrivningen av API:et i redigeringsfönstret för att ta bort det http-protokoll som används för åtkomst till API:et. Välj sedan Arkiv > Spara.

Om du vill redigera OpenAPI-formatet högerklickar du på API-namnet i Explorer-fönstret och väljer Redigera OpenAPI. Gör dina ändringar och välj sedan Arkiv > Spara.

Tillämpa principer på API:et

API Management innehåller principer som du kan konfigurera för dina API:er. Principer är en samling instruktioner som körs sekventiellt på begäran av eller efter ett svar från ett API. Principer kan vara globala, som gäller för alla API:er i din API Management instans, eller så kan de vara begränsade till en specifik API- eller API-åtgärd.

Det här avsnittet visar hur du använder några vanliga utgående principer för ditt API som transformerar API-svaret. Principerna i det här exemplet ändrar svarshuvuden och döljer ursprungliga url:er för backend som visas i svarstexten.

1. I Explorer-fönstret väljer du Princip under demo-conference-api:et som du importerade. Principfilen öppnas i redigeringsfönstret. Den här filen konfigurerar principer för alla åtgärder i API:et.

2. Uppdatera filen med följande innehåll i <outbound> -elementet:

   [...]
   <outbound>
       <set-header name="Custom" exists-action="override">
           <value>"My custom value"</value>
       </set-header>
       <set-header name="X-Powered-By" exists-action="delete" />
       <redirect-content-urls />
       <base />
   </outbound>
   [...]
   

   • Den första set-header principen lägger till ett anpassat svarshuvud i demonstrationssyfte.
   • Den andra set-header principen tar bort huvudet X-Powered-By, om det finns. Det här huvudet kan visa det programramverk som används i API-backend och utgivare tar ofta bort det.
   • Principen skriver om (maskerar) länkar i svarstexten så att de pekar på motsvarande länkar redirect-content-urls via API Management gateway.

3. Spara filen. Om du uppmanas väljer du Upload för att ladda upp filen till molnet.

Testa API:et

Hämta prenumerationsnyckeln

Om du vill testa det importerade API:et som du har importerat och de principer som tillämpas behöver du en prenumerationsnyckel för din API Management instans.

1. I Explorer-fönstret högerklickar du på namnet på din API Management instans.

2. Välj Kopiera prenumerationsnyckel.

   

Testa en API-åtgärd

1. I Explorer-fönstret expanderar du noden Åtgärder under demo-conference-api:et som du har importerat.
2. Välj en åtgärd, till exempel GetSpeakers, och högerklicka sedan på åtgärden och välj Testa åtgärd.
3. I redigeringsfönstret bredvid Ocp-Apim-Subscription-Key ersätter du {{SubscriptionKey}} med den prenumerationsnyckel som du kopierade.
4. Välj Skicka begäran.

När begäran lyckas svarar backend med 200 OK och vissa data.

Lägg märke till följande information i svaret:

• Det anpassade huvudet läggs till i svaret.
• Huvudet X-Powered-By visas inte i svaret.
• URL:er till API-backend omdirigeras till API Management gateway, i det här fallet https://apim-hello-world.azure-api.net/demo-conference-api .

Spåra API-åtgärden

Om du vill ha detaljerad spårningsinformation som hjälper dig att felsöka API-åtgärden väljer du länken som visas bredvid Ocp-APIM-Trace-Location.

JSON-filen på den platsen innehåller inkommande, backend- och utgående spårningsinformation så att du kan avgöra var eventuella problem uppstår när begäran har gjorts.

Rensa resurser

När instansen inte längre behövs tar API Management bort den genom att högerklicka och välja Öppna i portalen för att ta bort API Management-tjänsten och dess resursgrupp.

Alternativt kan du välja Ta bort API Management att bara ta API Management instansen (den här åtgärden tar inte bort dess resursgrupp).

Nästa steg

I den här självstudien introducerades flera funktioner i API Management Extension for Visual Studio Code som du kan använda för att importera och hantera API:er. Du har lärt dig att:

Tillägget API Management innehåller ytterligare funktioner som fungerar med dina API:er. Du kan till exempel felsöka (finns på tjänstnivån Utvecklare) eller skapa och hantera namngivna värden.