Tutorial: Simulieren von API-Antworten

GILT FÜR: Alle API Management-Ebenen

Back-End-APIs können in eine APIM-API (API Management) importiert oder manuell erstellt und verwaltet werden. In den Schritten in diesem Tutorial wird Folgendes gezeigt:

• Verwenden von API Management zum Erstellen einer leeren HTTP-API
• Manuelles Verwalten einer HTTP-API
• Festlegen einer Richtlinie für eine API, sodass sie eine simulierte Antwort zurückgibt

Mit dieser Methode können Entwickler*innen mit der Implementierung und dem Testen der API Management-Instanz fortfahren, auch wenn das Back-End nicht zum Senden echter Antworten verfügbar ist.

Die Möglichkeit zum Simulieren von Antworten ist in vielen Szenarien nützlich:

• Die API-Facade wird entworfen, bevor das Back-End implementiert wird. Oder das Back-End wird parallel entwickelt.
• Das Back-End ist vorübergehend nicht betriebsbereit, oder es kann nicht skaliert werden.

In diesem Tutorial lernen Sie Folgendes:

• Erstellen einer Test-API
• Hinzufügen eines Vorgangs zur Test-API
• Aktivieren der Antwortsimulation
• Testen der simulierten API

Voraussetzungen

• Machen Sie sich mit der Azure API Management-Terminologie vertraut.
• Machen Sie sich mit dem Konzept von Richtlinien in Azure API Management vertraut.
• Bearbeiten Sie den folgenden Schnellstart: Erstellen einer neuen Azure API Management-Dienstinstanz

Erstellen einer Test-API

In diesem Abschnitt erfahren Sie, wie Sie eine HTTP-API ohne Back-End erstellen.

1. Melden Sie sich beim Azure-Portal an, und navigieren Sie zu Ihrer API Management-Instanz.

2. Wählen Sie APIs>+ API hinzufügen>HTTP-Kachel aus.

   

3. Wählen Sie im Fenster HTTP-API erstellen die Option Vollständig aus.

4. Geben Sie Test API unter Anzeigename ein.

5. Wählen Sie Unbegrenzt für Produkte ein.

6. Stellen Sie sicher, dass Verwaltet für Gateways ausgewählt ist.

7. Klicken Sie auf Erstellen.

   

Hinzufügen eines Vorgangs zur Test-API

Eine API macht mindestens einen Vorgang verfügbar. In diesem Abschnitt fügen Sie der von Ihnen erstellten HTTP-API einen Vorgang hinzu. Das Aufrufen des Vorgangs nach Abschluss der Schritte in diesem Abschnitt löst einem Fehler aus. Sie erhalten keine Fehler mehr, nachdem die Schritte im Abschnitt Aktivieren der Antwortsimulation abgeschlossen wurden.

Portal

1. Wählen Sie die API aus, die Sie im vorherigen Schritt erstellt haben.

2. Klicken Sie auf + Vorgang hinzufügen.

3. Geben Sie im Fenster Front-End die folgenden Werte ein.

   

   Einstellung	Wert	BESCHREIBUNG
   Anzeigename	Test call	Der im Entwicklerportal angezeigte Name.
   URL (HTTP-Verb)	GET	Wählen Sie eines der vordefinierten HTTP-Verben aus.
   URL	/test	Ein URL-Pfad für die API.
   Beschreibung		Optionale Beschreibung des Vorgangs, die als Dokumentation im Entwicklerportal für Entwickler dient, die diese API verwenden.

4. Wählen Sie die Registerkarte Antworten unter den Feldern „URL“, „Anzeigename“ und „Beschreibung“ aus. Geben Sie auf dieser Registerkarte Einstellungen ein, die Statuscodes, Inhaltstypen, Beispiele und Schemas für die Antwort definieren.

5. Wählen Sie + Antwort hinzufügen und dann aus der Liste 200 OK aus.

   

6. Wählen Sie unter der Überschrift Darstellungen auf der rechten Seite + Darstellung hinzufügen aus.

7. Geben Sie application/json in das Suchfeld ein, und wählen Sie den Inhaltstyp application/json aus.

8. Geben Sie im Textfeld Beispiel{ "sampleField" : "test" } ein.

9. Wählen Sie Speichern aus.

   

Obwohl für dieses Beispiel nicht erforderlich, können Sie weitere Einstellungen für einen API-Vorgang auf anderen Registerkarten konfigurieren, einschließlich:

Registerkarte	BESCHREIBUNG
Abfrage	Fügen Sie Abfrageparameter hinzu. Neben einem Namen und einer Beschreibung können Sie auch Werte angeben, die einem Abfrageparameter zugewiesen werden. Sie können einen der Werte als Standardwert (optional) markieren.
Anforderung	Definieren Sie Inhaltstypen, Beispiele und Schemas für die Anforderung.

Azure-Befehlszeilenschnittstelle

So beginnen Sie mit der Verwendung der Azure CLI:

• Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter Schnellstart für Bash in Azure Cloud Shell.

  

• Wenn Sie CLI-Referenzbefehle lieber lokal ausführen, installieren Sie die Azure CLI. Wenn Sie Windows oder macOS ausführen, sollten Sie die Azure CLI in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Ausführen der Azure CLI in einem Docker-Container.

  • Wenn Sie eine lokale Installation verwenden, melden Sie sich mithilfe des Befehls az login bei der Azure CLI an. Führen Sie die in Ihrem Terminal angezeigten Schritte aus, um den Authentifizierungsprozess abzuschließen. Informationen zu anderen Anmeldeoptionen finden Sie unter Anmelden mit der Azure CLI.

  • Installieren Sie die Azure CLI-Erweiterung beim ersten Einsatz, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden von Erweiterungen mit der Azure CLI.

  • Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um das Upgrade auf die aktuelle Version durchzuführen.

Führen Sie den Befehl az apim api operation create aus, um der Test-API einen Vorgang hinzuzufügen.

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 

Führen Sie den Befehl az apim api operation list aus, um alle Vorgänge für eine API anzuzeigen:

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

Führen Sie zum Entfernen eines Vorgangs den Befehl az apim api operation delete aus. Rufen Sie die Vorgangs-ID über den vorherigen Befehl ab.

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

Verwenden Sie diesen Vorgang auch im restlichen Artikel.

Aktivieren der Antwortsimulation

1. Wählen Sie die API aus, die Sie im Schritt Erstellen einer Test-API erstellt haben.

2. Vergewissern Sie sich im Fenster rechts, dass die Registerkarte Entwurf ausgewählt ist.

3. Wählen Sie den Testvorgang aus, den Sie hinzugefügt haben.

4. Wählen Sie im Fenster Eingehende Verarbeitung die Option + Richtlinie hinzufügen aus.

   

5. Wählen Sie im Katalog die Option Mock responses (Modellantworten) aus.

   

6. Geben Sie im Textfeld API Management response (API Management-Antwort) die Zeichenfolge 200 OK, application/json ein. Diese Auswahl gibt an, dass Ihre API das Antwortbeispiel zurückgeben soll, das Sie im vorherigen Abschnitt definiert haben.

   

7. Wählen Sie Speichern aus.

   Tipp

   Ein gelber Balken mit dem Text Mocking is enabled (Modellieren ist aktiviert) wird angezeigt. Dies gibt an, dass die von API Management zurückgegenemem Amtworten von der Modellrichtlinie simuliert und nicht vom Back-End erzeugt werden.

Testen der simulierten API

1. Wählen Sie die API aus, die Sie im Schritt Erstellen einer Test-API erstellt haben.

2. Wählen Sie die Registerkarte Testen aus.

3. Stellen Sie sicher, dass die API für Testaufrufe ausgewählt ist, und wählen Sie dann Senden aus, um einen Testaufruf zu senden.

   

4. In HTTP-Antwort wird der JSON-Code angezeigt, der als Beispiel im ersten Abschnitt des Tutorials angegeben wurde.

   

Nächste Schritte

In diesem Tutorial haben Sie Folgendes gelernt:

• Erstellen einer Test-API
• Hinzufügen eines Vorgangs zur Test-API
• Aktivieren der Antwortsimulation
• Testen der simulierten API

Fahren Sie mit dem nächsten Tutorial fort:

Transformieren und Schützen einer veröffentlichten API