Zelfstudie: Gesimuleerde antwoorden van een API

Artikel
09/28/2021
5 minuten om te lezen

Back-end API's worden geïmporteerd in een APIM-API (API Management) of handmatig gemaakt en beheerd. Met de stappen in deze zelfstudie leert u hoe u APIM kunt gebruiken om een lege API te maken en deze handmatig te beheren, en vervolgens een beleid in te stellen voor een API om deze een gesimuleerd antwoord te laten retourneren. Deze methode maakt het voor ontwikkelaars mogelijk om verder te gaan met het implementeren en testen van de instantie van APIM, zelfs wanneer de back-end niet beschikbaar is voor het verzenden van echte antwoorden.

De mogelijkheid om gesimuleerde antwoorden te genereren kan nuttig zijn bij een aantal scenario's:

Als de API-kant het eerst wordt ontworpen en de back-end implementatie later volgt. Of als de back-end parallel wordt ontwikkeld.
Wanneer de back-end tijdelijk niet operationeel is of niet kan worden geschaald.

In deze zelfstudie leert u het volgende:

Een test-API maken
Een bewerking aan de test-API toevoegen
Antwoordsimulatie inschakelen
De gesimuleerde API testen

Gesimuleerd API-antwoord

Vereisten

Informatie over de terminologie van Azure API Management.
Inzicht in het beleidsconcept in Azure API Management.
Voltooi de volgende quickstart: Een Azure API Management-exemplaar maken.

Een test-API maken

De stappen in deze sectie laten zien hoe u een lege API zonder back-end maakt.

Meld u aan bij de Azure-portal en ga naar uw API Management-exemplaar.
Selecteer APIs > + Add API (API toevoegen) > Blank API (Lege API).
Selecteer Full (Volledig) in het venster Create a Blank API (Een lege API maken).
Voer Test API in als Display name (Weergavenaam).
Voer Unlimited (Onbeperkt) in bij Products (Producten).
Zorg ervoor dat Managed (Beheerd) is geselecteerd in Gateways.
Selecteer Maken.

Een bewerking aan de test-API toevoegen

Een API stelt een of meer bewerkingen beschikbaar. In deze sectie voegt u een bewerking toe aan de lege API die u hebt gemaakt. Bij het aanroepen van de bewerking na het voltooien van de stappen in deze sectie, treedt een fout op. Na voltooiing van de stappen in de sectie Antwoordsimulatie inschakelen krijgt u geen foutmeldingen meer.

Portal
Azure-CLI

Selecteer de API die u in de vorige stap hebt gemaakt.
Klik op + Bewerking toevoegen.

Voer in het Frontend-venster de volgende waarden in.

Instelling	Waarde	Beschrijving
Weergavenaam	Test call (Testaanroep)	De naam die wordt weergegeven in de ontwikkelaarsportal.
URL (HTTP-woord)	GET	Selecteer een van de vooraf gedefinieerde HTTP-woorden.
URL	/test	Een URL-pad voor de API.
Deschription (Beschrijving)		Optionele beschrijving van de bewerking, die wordt gebruikt om de ontwikkelaars die gebruikmaken van deze API in de ontwikkelaarsportal van documentatie te voorzien.

Selecteer het tabblad Responses (Antwoorden), dat zich bevindt onder de velden URL, Display name (Weergavenaam) en Description (Beschrijving). Voer instellingen op dit tabblad in om antwoordstatuscodes, inhoudstypen, voorbeelden en schema's te definiëren.
Selecteer + Add response (Antwoord toevoegen) en selecteer 200 OK in de lijst.
Selecteer + Add representation ( Weergave toevoegen) onder de kop Representations (Representaties) aan de rechterkant.
Voer application/json in het zoekvak in en selecteer het inhoudstype application/json.
Voer in het tekstvak Sample (Voorbeeld) { "sampleField" : "test" } in.
Selecteer Save (Opslaan).

API-bewerking toevoegen

Hoewel dit niet vereist is voor dit voorbeeld, kunnen er op andere tabbladen aanvullende instellingen voor een API-bewerking worden geconfigureerd, waaronder:

Tabblad	Beschrijving
Query	Voeg queryparameters toe. Naast het invoeren van een naam en beschrijving, kunt u waarden opgeven die worden toegewezen aan een queryparameter. Een van de waarden kan worden gemarkeerd als standaardwaarde (optioneel).
Aanvraag	Definieer aanvraaginhoudstypen, voorbeelden en schema's.

Als u Azure CLI wilt gaan gebruiken, gaat u als volgende te werk:

Gebruik de bash-omgeving in Azure Cloud shell.
Installeer de Azure CLI, indien gewenst, om CLI-referentieopdrachten uit te voeren.
- Als u een lokale installatie gebruikt, meldt u zich aan bij Azure CLI met behulp van de opdracht AZ login. Volg de stappen die worden weergegeven in de terminal, om het verificatieproces te voltooien. Raadpleeg Aanmelden bij de Azure CLI voor aanvullende aanmeldingsopties.
- Installeer de Azure CLI-extensie bij het eerste gebruik, wanneer u hierom wordt gevraagd. Raadpleeg Extensies gebruiken met Azure CLI voor meer informatie over extensies.
- Voer az version uit om de geïnstalleerde versie en afhankelijke bibliotheken te vinden. Voer az upgrade uit om te upgraden naar de nieuwste versie.

Als u een bewerking wilt toevoegen aan uw test-API, moet u de opdracht az apim api operation create uitvoeren:

az apim api operation create --resource-group apim-hello-word-resource-group \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name apim-hello-world

Voer de opdracht az apim api operation list uit om al uw bewerkingen voor een API te bekijken:

az apim api operation list --resource-group apim-hello-word-resource-group \
    --api-id test-api --service-name apim-hello-world --output table

Als u een bewerking wilt verwijderen, gebruikt u de opdracht az apim api operation delete. Haal de bewerkings-id op uit de vorige opdracht.

az apim api operation delete --resource-group apim-hello-word-resource-group \
    --api-id test-api --operation-id 00000000000000000000000000000000 \
    --service-name apim-hello-world

Bewaar deze bewerking voor gebruik in de rest van dit artikel.

Antwoordsimulatie inschakelen

Selecteer de API die u in de stap Een test-API maken hebt gemaakt.
Selecteer de testbewerking die u hebt toegevoegd.
Zorg ervoor dat in het venster aan de rechterkant het tabblad Design (Ontwerp) is geselecteerd.
Selecteer het venster Inbound processing (Binnenkomende verwerking) + Add policy (Beleid toevoegen).
Selecteer Mock responses (Gesimuleerde antwoorden) uit de galerie.
Typ 200 OK, application/json in het tekstvak API Management response. Deze selectie geeft aan dat uw API het voorbeeldantwoord moet retourneren dat u hebt gedefinieerd in de vorige sectie.
Selecteer Save (Opslaan).

Tip

Een gele balk met de tekst Simuleren is ingeschakeld voor uw API geeft aan dat reacties die worden geretourneerd door API Management worden gesimuleerd door het simulatiebeleid en niet worden geproduceerd door de back-end.

De gesimuleerde API testen

Selecteer de API die u in de stap Een test-API maken hebt gemaakt.
Selecteer het tabblad Testen.
Zorg ervoor dat de Testaanroep-API is geselecteerd. Selecteer Verzenden om een testaanroep uit te voeren.
Het HTTP-antwoord geeft de JSON weer die is opgegeven als een voorbeeld in de eerste sectie van de zelfstudie.

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

Een test-API maken
Een bewerking aan de test-API toevoegen
Antwoordsimulatie inschakelen
De gesimuleerde API testen

Ga door naar de volgende zelfstudie:

Een gepubliceerde API transformeren en beveiligen