Simulieren von API-AntwortenMock API responses

Back-End-APIs können in eine API-APIM importiert oder manuell erstellt und verwaltet werden.Backend APIs can be imported into an APIM API or created and managed manually. Die Schritte in diesem Tutorial veranschaulichen das Verwenden von APIM zum Erstellen einer leeren API, die manuell verwaltet wird.The steps in this tutorial show you how to use APIM to create a blank API and manage it manually. Im Tutorial wird gezeigt, wie Sie eine Richtlinie für eine API festlegen, damit diese eine simulierte Antwort zurückgibt.The tutorial shows how to set a policy on an API so it returns a mocked response. Diese Methode ermöglicht Entwicklern das Fortsetzen von Implementierung und Tests der APIM-Instanz, selbst wenn das Back-End nicht verfügbar ist und keine echten Antworten senden kann.This method enables developers to proceed with implementation and testing of the APIM instance even if the backend is not available to send real responses. Die Möglichkeit zum Simulieren von Antworten kann in verschiedenen Szenarien nützlich sein:Ability to mock up responses can be useful in a number of scenarios:

  • Die API-Facade wird entworfen, bevor das Back-End implementiert wird.When the API façade is designed first and the backend implementation comes later. Oder das Back-End wird parallel entwickelt.Or, the backend is being developed in parallel.
  • Das Back-End ist vorübergehend nicht betriebsbereit, oder es kann nicht skaliert werden.When the backend is temporarily not operational or not able to scale.

In diesem Tutorial lernen Sie Folgendes:In this tutorial, you learn how to:

  • Erstellen einer Test-APICreate a test API
  • Hinzufügen eines Vorgangs zur Test-APIAdd an operation to the test API
  • Aktivieren der AntwortsimulationEnable response mocking
  • Testen der simulierten APITest the mocked API

Simulierte Antwort auf einen Vorgang

VoraussetzungenPrerequisites

Erstellen einer Test-APICreate a test API

In diesem Abschnitt erfahren Sie, wie Sie eine leere API ohne Back-End erstellen.The steps in this section show how to create a blank API with no backend. Außerdem wird gezeigt, wie Sie der API einen Vorgang hinzufügen.It also shows how to add an operation to the API. Das Aufrufen des Vorgangs nach Abschluss der Schritte in diesem Abschnitt führt zu einem Fehler.Calling the operation after completing steps in this section produces an error. Sie erhalten keine Fehler mehr, nachdem die Schritte im Abschnitt „Aktivieren der Antwortsimulation“ abgeschlossen wurden.You will get no errors after you complete steps in the "Enable response mocking" section.

Erstellen einer leeren API

  1. Wählen Sie im API Management-Dienst APIs aus.Select APIs from the API Management service.
  2. Wählen Sie im linken Menü die Option + API hinzufügen aus.From the left menu, select + Add API.
  3. Wählen Sie in der Liste Leere API aus.Select Blank API from the list.
  4. Geben Sie „Test API“ als Anzeigename ein.Enter "Test API" for Display name.
  5. Geben Sie „Unlimited“ für Produkte ein.Enter "Unlimited" for Products.
  6. Klicken Sie auf Erstellen.Select Create.

Hinzufügen eines Vorgangs zur Test-APIAdd an operation to the test API

Hinzufügen eines Vorgangs zur API

  1. Wählen Sie die API aus, die Sie im vorherigen Schritt erstellt haben.Select the API you created in the previous step.

  2. Klicken Sie auf + Vorgang hinzufügen.Click + Add Operation.

    EinstellungSetting WertValue BESCHREIBUNGDescription
    AnzeigenameDisplay name Test callTest call Dieser Name wird im Entwicklerportal angezeigt.The name that is displayed in the Developer portal.
    URL (HTTP-Verb)URL (HTTP verb) GETGET Sie können eines der vordefinierten HTTP-Verben auswählen.You can choose from one of the predefined HTTP verbs.
    URLURL /test/test Ein URL-Pfad für die API.A URL path for the API.
    BeschreibungDescription Geben Sie eine Beschreibung für den Vorgang an, die als Dokumentation für Entwickler dient, die diese API im Entwicklerportal verwenden.Provide a description of the operation that is used to provide documentation to the developers using this API in the Developer portal.
    Registerkarte AbfrageQuery tab Sie können Abfrageparameter hinzufügen.You can add query parameters. Neben einem Namen und einer Beschreibung können Sie Werte angeben, die diesem Parameter zugewiesen werden können.Besides providing a name and description, you can provide values that can be assigned to this parameter. Einer der Werte kann als Standard markiert werden (optional).One of the values can be marked as default (optional).
    Registerkarte AnforderungRequest tab Sie können Inhaltstypen für die Anforderung, Beispiele und Schemas definieren.You can define request content types, examples, and schemas.
    Registerkarte AntwortResponse tab Sehen Sie sich Schritte in dieser Tabelle an.See steps that follow this table. Definieren Sie Statuscodes, Inhaltstypen, Beispiele und Schemas für die Antwort.Define response status codes, content types, examples, and schemas.
  3. Wählen Sie die Registerkarte Antwort unter den Feldern „URL“, „Anzeigename“ und „Beschreibung“ aus.Select the Response tab, located under the URL, Display name, and Description fields.

  4. Klicken Sie auf + Antwort hinzufügen.Click + Add response.

  5. Wählen Sie 200 OK in der Liste aus.Select 200 OK from the list.

  6. Wählen Sie unter der Überschrift Darstellungen auf der rechten Seite + Darstellung hinzufügen aus.Under the Representations heading on the right, select + Add representation.

  7. Geben Sie „application/json“ in das Suchfeld ein, und wählen Sie den Inhaltstyp application/json aus.Enter "application/json" into the search box and select the application/json content type.

  8. Geben Sie im Testfeld Beispiel { "sampleField" : "test" } ein.In the Sample text box, enter { "sampleField" : "test" }.

  9. Klicken Sie auf Erstellen.Select Create.

Aktivieren der AntwortsimulationEnable response mocking

Aktivieren der Antwortsimulation

  1. Wählen Sie die API aus, die Sie im Schritt „Erstellen einer Test-API“ erstellt haben.Select the API you created in the "Create a test API" step.

  2. Wählen Sie den Testvorgang aus, den Sie hinzugefügt haben.Select the test operation that you added.

  3. Klicken Sie im Fenster auf der rechten Seite auf die Registerkarte Entwurf.In the window on the right, click the Design tab.

  4. Klicken Sie im Fenster Eingehende Verarbeitung auf + Richtlinie hinzufügen.In the Inbound processing window, click + Add policy.

  5. Wählen Sie im Katalog die Kachel Mock responses (Modellantworten) aus.Select the Mock responses tile from the gallery.

    Kachel mit der Richtlinie für Modellantworten

  6. Geben Sie im Textfeld API Management response (API Management-Antwort) die Zeichenfolge 200 OK, application/json ein.In the API Management response textbox, type 200 OK, application/json. Diese Auswahl gibt an, dass Ihre API das Antwortbeispiel zurückgeben soll, das Sie im vorherigen Abschnitt definiert haben.This selection indicates that your API should return the response sample you defined in the previous section.

    Aktivieren der Antwortsimulation

  7. Klicken Sie auf Speichern.Click Save.

Testen der simulierten APITest the mocked API

Testen der simulierten API

  1. Wählen Sie die API aus, die Sie im Schritt „Erstellen einer Test-API“ erstellt haben.Select the API you created in the "Create a test API" step.

  2. Öffnen Sie die Registerkarte Testen.Open the Test tab.

  3. Vergewissern Sie sich, dass die Testaufruf-API ausgewählt ist.Ensure the Test call API is selected.

    Tipp

    Ein gelber Balken mit dem Text Die Antwortsimulation ist aktiviert gibt an, dass die von API Management zurückgegebenen Antworten einer Simulationsrichtlinie folgen und keine tatsächliche Back-End-Antwort darstellen.A yellow bar with the text Mocking is enabled indicates that responses returned from the API Management, sends a mocking policy and not an actual backend response.

  4. Wählen Sie Senden aus, um einen Testaufruf durchzuführen.Select Send to make a test call.

  5. In HTTP-Antwort wird der JSON-Code angezeigt, der als Beispiel im ersten Abschnitt des Tutorials angegeben wurde.The HTTP response displays the JSON provided as a sample in the first section of the tutorial.

    Aktivieren der Antwortsimulation

VideoVideo

Nächste SchritteNext steps

In diesem Tutorial haben Sie Folgendes gelernt:In this tutorial, you learned how to:

  • Erstellen einer Test-APICreate a test API
  • Hinzufügen eines Vorgangs zur Test-APIAdd an operation to the test API
  • Aktivieren der AntwortsimulationEnable response mocking
  • Testen der simulierten APITest the mocked API

Fahren Sie mit dem nächsten Tutorial fort:Advance to the next tutorial: