Zelfstudie: De Azure API Management-extensie voor Visual Studio Code gebruiken om API's te importeren en te beheren

VAN TOEPASSING OP: Verbruik | Ontwikkelaar | Basic | Standaard | Premium

In deze zelfstudie leert u hoe u de API Management-extensie voor Visual Studio Code gebruikt voor algemene bewerkingen in API Management. Gebruik de vertrouwde Visual Studio Code-omgeving om API's te importeren, te testen en te beheren.

U leert het volgende:

• Een API importeren in API Management
• De API bewerken
• API Management-beleid toepassen
• De API testen

Voor een inleiding tot meer API Management-functies raadpleegt u de ZELFSTUDIEs voor API Management met behulp van Azure Portal.

Vereisten

• Kennis van de terminologie van Azure API Management.
• Zorg ervoor dat u Visual Studio Code en de nieuwste Azure API Management-extensie voor Visual Studio Code hebt geïnstalleerd.
• Maak een API Management-exemplaar.

Een API importeren

In het volgende voorbeeld wordt een OpenAPI-specificatie in de JSON-indeling geïmporteerd in API Management. Microsoft biedt de back-end-API die in dit voorbeeld wordt gebruikt en host deze op Azure op https://conferenceapi.azurewebsites.net.

1. Selecteer in Visual Studio Code het Azure-pictogram op de Activiteitenbalk.
2. Vouw in het deelvenster Verkenner het API Management-exemplaar uit dat u hebt gemaakt.
3. Klik met de rechtermuisknop op API's en selecteer Importeren vanuit OpenAPI-koppeling.
4. Voer de volgende waarden in wanneer u hierom wordt gevraagd:

   1. Een OpenAPI-koppeling voor inhoud in de JSON-indeling. Voor dit voorbeeld: https://conferenceapi.azurewebsites.net?format=json.

      Dit bestand geeft de back-endservice op die de voorbeeld-API implementeert, in dit geval https://conferenceapi.azurewebsites.net. API Management stuurt aanvragen door naar deze webservice.

   2. Een API-naam, zoals demo-conference-api, die uniek is in het API Management-exemplaar. Deze naam mag alleen letters, cijfers en afbreekstreepjes bevatten. Het eerste en laatste teken moeten alfanumeriek zijn. Deze naam wordt gebruikt in het pad om de API aan te roepen.

Nadat de API is geïmporteerd, wordt deze weergegeven in het deelvenster Verkenner, en beschikbare API-bewerkingen worden weergegeven onder het knooppunt Bewerkingen.

De API bewerken

U kunt de API bewerken in Visual Studio Code. Bewerk bijvoorbeeld de Resource Manager JSON-beschrijving van de API in het editorvenster om het HTTP-protocol te verwijderen dat wordt gebruikt voor toegang tot de API.

Klik met de rechtermuisknop op de API-naam in het deelvenster Verkenner, en selecteer OpenAPI bewerken om de OpenAPI-indeling te bewerken. Breng uw wijzigingen aan en selecteer vervolgens Bestand>Opslaan.

Beleid toepassen op de API

API Management biedt beleidsregels die u kunt configureren voor uw API's. Beleidsregels zijn een verzameling instructies. Deze instructies worden opeenvolgend uitgevoerd op de aanvraag of het antwoord van een API. Beleidsregels kunnen globaal zijn, die van toepassing zijn op alle API's in uw API Management-exemplaar, of specifiek voor een product, een API of een API-bewerking.

In deze sectie wordt beschreven hoe u veelvoorkomend uitgaand beleid toepast op uw API waarmee het API-antwoord wordt getransformeerd. Op basis van de beleidsregels in dit voorbeeld wordt de actiekoptekst gewijzigd, en worden oorspronkelijke back-end-URL's in de antwoordkoptekst verborgen.

1. Selecteer in het deelvenster Verkenner de optie Beleid onder de demo-conference-api die u hebt geïmporteerd. Het beleidsbestand wordt geopend in het editorvenster. Met dit bestand worden beleidsregels geconfigureerd voor alle bewerkingen in de API.

2. Werk het bestand bij met de volgende inhoud in het element <outbound>:

   [...]
   <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>
   [...]
   

   • Op basis van het eerste set-header-beleid wordt een aangepaste antwoordkoptekst toegevoegd voor demonstratiedoeleinden.
   • Op basis van het tweede set-header-beleid wordt de koptekst X-Powered-By verwijderd, als deze bestaat. Met deze koptekst kan het toepassingsframework worden onthuld dat is gebruikt in de API-back-end. Uitgevers verwijderen deze vaak.
   • Op basis van redirect-content-urls-beleid worden koppelingen (maskers) opnieuw geschreven, zodat ze verwijzen naar de equivalente koppelingen via de API Management-gateway.

3. Sla het bestand op. Als u hierom wordt gevraagd, selecteert u Uploaden om het bestand naar de cloud te uploaden.

De API testen

Als u de API wilt testen, haalt u een abonnementssleutel op en doet u vervolgens een aanvraag naar de API Management-gateway.

De abonnementssleutel ophalen

U hebt een abonnementssleutel nodig voor uw API Management-exemplaar om de geïmporteerde API en het toegepaste beleid te testen.

1. Klik in het deelvenster Verkenner met de rechtermuisknop op de naam van uw API Management-exemplaar.

2. Selecteer Abonnementssleutel kopiëren. Deze sleutel is bedoeld voor het ingebouwde abonnement voor alle toegang dat wordt gemaakt wanneer u een API Management-exemplaar maakt.

   

   Let op

   Het abonnement voor alle toegang maakt toegang tot elke API in dit API Management-exemplaar mogelijk en mag alleen worden gebruikt door geautoriseerde gebruikers. Gebruik deze nooit voor routine-API-toegang of sluit de sleutel voor alle toegang in client-apps in.

Een API-bewerking testen

1. Vouw in het deelvenster Verkenner het knooppunt Bewerkingen uit onder de demo-conference-api die u hebt geïmporteerd.
2. Selecteer een bewerking zoals GetSpeakers en klik met de rechtermuisknop op de bewerking en selecteer Testbewerking.
3. Vervang in het editorvenster, naast Ocp-Apim-Subscription-Key, {{SubscriptionKey}} door de abonnementssleutel die u hebt gekopieerd.
4. Selecteer Verzoek verzenden.

Wanneer de aanvraag is geslaagd, reageert de back-end met 200 OK en enkele gegevens.

U ziet de volgende details in het antwoord:

• De koptekst Aangepast wordt toegevoegd aan het antwoord.
• De koptekst X-Powered-By wordt niet weergegeven in het antwoord.
• URL's naar de API-back-end worden omgeleid naar de API Management-gateway, in dit geval https://apim-hello-world.azure-api.net/demo-conference-api.

Verwerking van traceringsaanvragen

U kunt desgewenst gedetailleerde traceringsgegevens voor aanvragen ophalen om u te helpen bij het opsporen en oplossen van problemen met de API.

Zie Tracering inschakelen voor een API voor stappen voor het inschakelen van tracering voor een API. Om onbedoelde openbaarmaking van gevoelige informatie te beperken, is tracering standaard slechts 1 uur toegestaan.

Resources opschonen

Verwijder het API Management-exemplaar als u dit niet meer nodig hebt, door met de rechtermuisknop te klikken en Openen in portal te selecteren om de API Management-service en de bijbehorende resourcegroep te verwijderen.

U kunt ook API Management verwijderen selecteren om alleen het API Management-exemplaar te verwijderen (met deze bewerking wordt de resourcegroep niet verwijderd).

Gerelateerde inhoud

In deze zelfstudie zijn verschillende functies van de API Management-extensie voor Visual Studio Code geïntroduceerd. U kunt deze functies gebruiken om API's te importeren en te beheren. U hebt geleerd hoe u:

• Een API importeren in API Management
• De API bewerken
• API Management-beleid toepassen
• De API testen

De API Management-extensie biedt meer functies om met uw API's te werken. Bijvoorbeeld foutopsporing voor beleid (beschikbaar in de servicelaag voor ontwikkelaars), of het maken en beheren van benoemde waarden.