Tutorial: simulierte API-Antworten

GILT FÜR: Alle API Management-Ebenen

Back-End-APIs werden in eine Azure API-Verwaltungs-API importiert oder manuell erstellt und verwaltet. In den Schritten in diesem Lernprogramm wird beschrieben, wie Sie:

• Verwenden Sie die API-Verwaltung, um eine leere HTTP-API zu erstellen.
• Manuelles Verwalten einer HTTP-API.
• Legen Sie eine Richtlinie für eine API fest, sodass sie eine simulierte Antwort zurückgibt.

Mit dieser Methode können Entwickler mit der Implementierung und dem Testen der API-Verwaltungsinstanz fortfahren, auch wenn das Back-End nicht verfügbar ist, um echte Antworten zu senden.

Tipp

API-Teams können dieses Feature in Arbeitsbereichen verwenden. Arbeitsbereiche bieten isolierten Administrationszugriff auf APIs und ihre eigenen API-Runtimeumgebungen.

Die Möglichkeit, simulierte Antworten zu erstellen, ist in vielen Szenarien nützlich:

• Wenn die API-Fassade zuerst entworfen wird und die Back-End-Implementierung später erfolgt, oder wenn das Back-End parallel entwickelt wird.
• Wenn das Back-End vorübergehend nicht betriebsbereit ist oder nicht skaliert werden kann.

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

• Lernen Sie die Terminologie der API-Verwaltung kennen.
• Verstehen des Konzepts von Richtlinien in der API-Verwaltung.
• Absolvieren Sie den Schnellstart Erstellen einer Azure API Management-Instanz.

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 im Anzeigenamen"Test-API" ein.

5. Wählen Sie in "Produkte" "Unbegrenzt" aus, wenn dieser Wert verfügbar ist. Dieser Wert ist nur in einigen Ebenen verfügbar. Sie können den Wert für dieses Lernprogramm leer lassen, aber Sie müssen die API einem Produkt zuordnen, um ihn zu veröffentlichen. Weitere Informationen finden Sie unter Importieren und Veröffentlichen Ihrer ersten API.

6. Wählen Sie in Gateways"Verwaltet" aus, wenn diese Option verfügbar ist. (Diese Option ist nur in bestimmten Dienstebenen verfügbar.)

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. Nachdem Sie die Schritte im Abschnitt Antwortsimulierung aktivieren ausgeführt haben, wird keine Fehlermeldung angezeigt.

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 Frontend-Fenster die folgenden Werte ein:

   Einstellung	Wert	BESCHREIBUNG
   Anzeigename	Testanruf	Der Name, der im Entwicklerportal angezeigt wird.
   URL (erstes Feld)	GET	Wählen Sie eines der vordefinierten HTTP-Verben aus.
   URL (zweites Feld)	/Test	Ein URL-Pfad für die API.
   Beschreibung		Eine optionale Beschreibung des Vorgangs. Es stellt Dokumentation im Entwicklerportal den Entwicklern zur Verfügung, die die API verwenden.

   

4. Wählen Sie die Registerkarte "Antworten " aus, die sich unter den Feldern "URL", " Anzeigename" und "Beschreibung " befindet. Sie geben Werte auf dieser Registerkarte ein, um Antwortstatuscodes, Inhaltstypen, Beispiele und Schemas zu definieren.

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

   

6. Wählen Sie im Abschnitt "Representations " die Option +Darstellung hinzufügen aus.

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

8. Geben Sie im Feld Beispiel die Zeichenfolge { "sampleField" : "test" } ein.

9. Wählen Sie Speichern aus.

   

Obwohl es für dieses Beispiel nicht erforderlich ist, können Sie weitere Einstellungen für einen API-Vorgang auf anderen Registerkarten konfigurieren, wie in der folgenden Tabelle beschrieben:

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 "Erste Schritte mit 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. Um den Authentifizierungsprozess abzuschließen, führen Sie die in Ihrem Terminal angezeigten Schritte aus. Weitere Anmeldeoptionen finden Sie unter Authentifizieren bei Azure mithilfe der Azure CLI.

  • Installieren Sie die Azure CLI-Erweiterung bei der ersten Verwendung, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden und Verwalten 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 <resource-group> \
    --display-name "Test call" --api-id test-api --method GET \
    --url-template /test --service-name <API-management-service-name> 

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 <resource-group-name> \
    --api-id test-api --service-name <API-management-service-name> --output table

Verwenden Sie diesen Vorgang auch im restlichen Artikel. Wenn Sie einen Vorgang entfernen möchten, können Sie den Befehl zum Löschen des az apim-API-Vorgangs verwenden. Rufen Sie die Vorgangs-ID über den vorherigen Befehl ab.

az apim api operation delete --resource-group <resource-group-name> \
    --api-id test-api --operation-id <ID> \
    --service-name <API-management-service-name>

Aktivieren der Antwortsimulation

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

2. Stellen Sie sicher, dass die Registerkarte " Entwurf " ausgewählt ist.

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

4. Klicken Sie im Abschnitt Eingehende Verarbeitung auf Richtlinie hinzufügen.

   

5. Wählen Sie die Kachel " Simulierte Antworten " aus dem Katalog aus:

   

6. Stellen Sie sicher , dass 200 OK, anwendung/json im Api-Verwaltungsantwortfeld angezeigt wird. 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 ist aktiviert" erscheint. Diese Meldung gibt an, dass die von API Management zurückgegebenen Antworten von der Simulationsrichtlinie 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. Stellen Sie auf der Registerkarte " Test " sicher, dass die Testaufruf-API ausgewählt ist, und wählen Sie dann "Senden" aus, um einen Testaufruf auszuführen:

   

3. Die HTTP-Antwort zeigt den JSON-Code an, der im ersten Abschnitt des Lernprogramms als Beispiel bereitgestellt wird:

   

Nächster Schritt

Gehen Sie zum nächsten Tutorial über:

Transformieren und Schützen einer veröffentlichten API