Zelfstudie: Gesimuleerde antwoorden van een API

Back-end-API's worden geïmporteerd in een APIM-API (API Management) of handmatig gemaakt en beheerd. De stappen in deze zelfstudie laten zien hoe u het volgende kunt doen:

  • Gebruik API Management om een lege HTTP-API te maken
  • Een HTTP-API handmatig beheren
  • Een beleid instellen voor een API, zodat er een gesimuleerd antwoord wordt geretourneerd

Met deze methode kunnen ontwikkelaars doorgaan met de implementatie en het testen van het API Management exemplaar, zelfs als de back-end niet beschikbaar is om echte antwoorden te verzenden.

De mogelijkheid om antwoorden te mocken is nuttig in veel 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

Mocked API response

Vereisten

Een test-API maken

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

  1. Meld u aan bij de Azure Portal en navigeer vervolgens naar uw API Management exemplaar.

  2. Selecteer API's>+ APIHTTP-tegeltoevoegen>.

    Define a HTTP API

  3. Selecteer in het venster Een HTTP-API maken de optie Volledig.

  4. Voer Test API in als Display name (Weergavenaam).

  5. Voer Unlimited (Onbeperkt) in bij Products (Producten).

  6. Zorg ervoor dat Beheerd is geselecteerd voor gateways.

  7. Selecteer Maken.

    Create an HTTP API

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 HTTP-API die u hebt gemaakt. Als u de bewerking aanroept nadat u de stappen in deze sectie hebt voltooid, wordt er een fout geactiveerd. Nadat u de stappen in de sectie Antwoordsimuleerd inschakelen hebt voltooid, krijgt u geen fouten.

  1. Selecteer de API die u in de vorige stap hebt gemaakt.

  2. Klik op + Bewerking toevoegen.

  3. Voer in het Frontend-venster de volgende waarden in.

    Frontend window

    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.
  4. 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.

  5. Selecteer + Add response (Antwoord toevoegen) en selecteer 200 OK in de lijst.

    Add response to the API operation

  6. Selecteer + Add representation ( Weergave toevoegen) onder de kop Representations (Representaties) aan de rechterkant.

  7. Voer application/json in het zoekvak in en selecteer het inhoudstype application/json.

  8. Voer in het tekstvak Voorbeeld de tekst in { "sampleField" : "test" }.

  9. Selecteer Opslaan.

    Add representation to the API operation

Hoewel dit voorbeeld niet is vereist, kunt u meer instellingen configureren voor een API-bewerking op andere tabbladen, waaronder:

Tabblad Beschrijving
Query Voeg queryparameters toe. Naast het opgeven van een naam en beschrijving kunt u ook waarden opgeven die zijn toegewezen aan een queryparameter. U kunt een van de waarden als standaard markeren (optioneel).
Aanvraag Definieer aanvraaginhoudstypen, voorbeelden en schema's.

Antwoordsimulatie inschakelen

  1. Selecteer de API die u in de stap Een test-API maken hebt gemaakt.

  2. Zorg ervoor dat in het venster aan de rechterkant het tabblad Design (Ontwerp) is geselecteerd.

  3. Selecteer de testbewerking die u hebt toegevoegd.

  4. Selecteer het venster Inbound processing (Binnenkomende verwerking) + Add policy (Beleid toevoegen).

    Add processing policy

  5. Selecteer Mock-antwoorden in de galerie.

    Mock responses policy tile

  6. 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.

    Set mocking response

  7. Selecteer Opslaan.

    Tip

    Er wordt een gele balk met de tekst mocking ingeschakeld . Dit geeft aan dat de antwoorden die zijn geretourneerd uit API Management worden gesimuleerd door het mockingbeleid en niet worden geproduceerd door de back-end.

De gesimuleerde API testen

  1. Selecteer de API die u in de stap Een test-API maken hebt gemaakt.

  2. Selecteer het tabblad Testen.

  3. Zorg ervoor dat de TEST-aanroep-API is geselecteerd en selecteer Verzenden om een testgesprek te voeren.

    Test the mocked API

  4. Het HTTP-antwoord geeft de JSON weer die is opgegeven als een voorbeeld in de eerste sectie van de zelfstudie.

    Mock HTTP response

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: