Tutorial: Verwenden der API Management-Erweiterung für Visual Studio Code zum Importieren und Verwalten von APIs

GILT FÜR: Verbrauch | Entwickler | Basis | Standard | Premium

In diesem Lernprogramm erfahren Sie, wie Sie die Azure API Management-Erweiterung für Visual Studio Code für allgemeine Vorgänge in der API-Verwaltung verwenden. Sie können die vertraute Visual Studio Code-Umgebung verwenden, um APIs zu importieren, zu aktualisieren, zu testen und zu verwalten.

Hinweis

Diese Funktion ist derzeit in Arbeitsbereichen nicht verfügbar.

In diesem Artikel erfahren Sie, wie Sie:

• Importieren einer API in API Management
• Bearbeiten der API
• Anwenden von Richtlinien für API Management
• Testen der API

Eine Einführung in weitere API-Verwaltungsfeatures finden Sie unter Importieren und Veröffentlichen Ihrer ersten API.

Voraussetzungen

• Machen Sie sich mit der Azure API Management-Terminologie vertraut.
• Installieren Sie Visual Studio Code und die neueste Azure API Management-Erweiterung für Visual Studio Code.
• Erstellen Sie eine API-Verwaltungsinstanz.

Importieren einer API

Im folgenden Beispiel wird eine OpenAPI-Spezifikation im JSON-Format in API Management importiert. In diesem Beispiel importieren Sie die Open-Source-Petstore-API.

1. Wählen Sie auf der Aktivitätsleiste in Visual Studio Code das Azure-Symbol aus.

2. Erweitern Sie im Explorer-Bereich die API Management-Instanz, die Sie erstellt haben.

3. Klicken Sie mit der rechten Maustaste auf APIs, und wählen Sie Aus OpenAPI-Link importieren aus.

4. Geben Sie die folgenden Werte ein, wenn Sie dazu aufgefordert werden:

   1. Einen OpenAPI-Link für Inhalte im JSON-Format. In diesem Beispiel: https://petstore.swagger.io/v2/swagger.json .

      Diese Datei gibt den Back-End-Dienst an, der die Beispiel-API und die unterstützten Vorgänge implementiert.

   2. Ein API-Name, z. B. Petstore, der in der API-Verwaltungsinstanz eindeutig ist. Der Name darf nur Buchstaben, Ziffern und Bindestriche enthalten. Das erste und das letzte Zeichen müssen alphanumerisch sein. Dieser Name wird im Pfad verwendet, um die API aufzurufen.

Nachdem die API erfolgreich importiert wurde, wird sie im Explorer-Bereich angezeigt, und die verfügbaren API-Vorgänge werden unter dem Knoten Vorgänge angezeigt.

Bearbeiten der API

Sie können die API in Visual Studio Code bearbeiten. Bearbeiten Sie z. B. die Resource Manager-JSON-Beschreibung der API im Editor-Fenster, um das http-Protokoll zu entfernen, das für den Zugriff auf die API verwendet wird und im folgenden Ausschnitt hervorgehoben wurde:

Um das OpenAPI-Format zu bearbeiten, klicken Sie im Explorer-Bereich mit der rechten Maustaste auf den API-Namen, und wählen Sie OpenAPI bearbeiten aus. Nehmen Sie die gewünschten Änderungen vor, und klicken Sie dann auf Datei>Speichern.

Anwenden von Richtlinien auf die API

API Management stellt Richtlinien bereit, die Sie für Ihre APIs konfigurieren können. Richtlinien sind eine Sammlung von Erklärungen. Diese Anweisungen werden sequenziell für die Anforderung oder Antwort einer API ausgeführt. Richtlinien können global sein, die für alle APIs in Ihrer API Management-Instanz oder spezifisch für ein Produkt, eine API oder einen API-Vorgang gelten.

In diesem Abschnitt wird gezeigt, wie Sie gängige ein- und ausgehende Richtlinien auf Ihre API anwenden.

1. Wählen Sie im Explorer-Bereich unter der importierten petstore-API die Option Richtlinie aus. Die Richtliniendatei wird im Editor-Fenster geöffnet. Diese Datei konfiguriert Richtlinien für alle Vorgänge in der API.

2. Aktualisieren Sie die Datei mit dem folgenden Inhalt:

   <policies>
       <inbound>
           <rate-limit calls="3" renewal-period="15" />
           <base />
       </inbound>
       <outbound>
           <set-header name="Custom" exists-action="override">
               <value>"My custom value"</value>
             </set-header>
           <base />
       </outbound>
       <on-error>
           <base />
       </on-error>
   </policies>
   

   • Die rate-limit Richtlinie im inbound Abschnitt beschränkt die Anzahl der Aufrufe der API auf 3 Aufrufe alle 15 Sekunden.
   • Mit der set-header-Richtlinie im Abschnitt outbound wird zu Demonstrationszwecken ein benutzerdefinierter Antwortheader hinzugefügt.

3. Speichern Sie die Datei. Klicken Sie bei entsprechender Aufforderung auf Hochladen, um die Datei in die Cloud hochzuladen.

Testen der API

Um die API zu testen, rufen Sie einen Abonnementschlüssel ab, und senden Sie dann eine Anforderung an das API Management-Gateway.

Abrufen des Abonnementschlüssels

Um die importierte API und die Richtlinien zu testen, die angewendet werden, benötigen Sie einen Abonnementschlüssel für Ihre API Management-Instanz.

1. Klicken Sie im Explorer-Bereich mit der rechten Maustaste auf den Namen Ihrer API Management-Instanz.

2. Wählen Sie Abonnementschlüssel kopieren aus. Dieser Schlüssel gilt für das integrierte Abonnement mit vollständigem Zugriff, das erstellt wird, wenn Sie eine API Management-Instanz erstellen.

   

   Achtung

   Das Abonnement mit vollständigem Zugriff ermöglicht den Zugriff auf jede API in dieser API Management-Instanz und sollte nur von autorisierten Benutzer*innen verwendet werden. Verwenden Sie es nie für den routinemäßigen API-Zugriff, und betten Sie den All-Access-Schlüssel nie in Client-Apps ein.

Testen eines API-Vorgangs

1. Erweitern Sie im Explorer-Bereich den Knoten Operations unter der petstore-API, die Sie importiert haben.

2. Wählen Sie einen Vorgang (z. B. [GET] Find pet by ID) aus, klicken Sie dann mit der rechten Maustaste auf den Vorgang, und wählen Sie Vorgang testen aus.

3. Ersetzen Sie im Editorfenster in der Anforderungs-URL 5 durch den petId-Parameter.

4. Fügen Sie im Editor-Fenster neben Ocp-Apim-Subscription-Key den von Ihnen kopierten Abonnementschlüssel ein.

5. Klicken Sie auf Anforderung senden.

   

Wenn die Anforderung erfolgreich ist, antwortet das Back-End mit 200 OK und einigen Daten.

Beachten Sie das folgende Detail in der Antwort:

• Der Antwort wird der Custom-Header hinzugefügt.

Testen Sie nun die Richtlinie zur Ratenbegrenzung. Wählen Sie Anforderung senden mehrmals in einer Zeile aus. Nachdem Sie zu viele Anforderungen im konfigurierten Zeitraum gesendet haben, erhalten Sie die Antwort 429 Too Many Requests.

Nachverfolgung der Anfrageverarbeitung

Optional können Sie detaillierte Informationen zur Anforderungsablaufverfolgung abrufen, die Sie beim Debuggen und bei der Problembehandlung Ihrer API unterstützen.

Schritte zum Aktivieren der Ablaufverfolgung für eine API finden Sie unter Aktivieren der Ablaufverfolgung für eine API. Um die unbeabsichtigte Offenlegung vertraulicher Informationen einzuschränken, ist die Nachverfolgung standardmäßig auf 1 Stunde beschränkt.

Bereinigen von Ressourcen

Wenn Sie die API Management-Instanz nicht mehr benötigen, können Sie diese entfernen, indem Sie mit der rechten Maustaste auf die Instanz klicken und Im Portal öffnen auswählen. Dort können Sie die API Management-Instanz und deren Ressourcengruppe löschen.

Alternativ können Sie " API-Verwaltung löschen " auswählen, um nur die API-Verwaltungsinstanz zu löschen. Dieser Vorgang löscht seine Ressourcengruppe nicht.

Zugehöriger Inhalt

Die API-Verwaltungserweiterung bietet weitere Features für die Arbeit mit Ihren APIs, z. B.:

• Erstellen, Verstehen und Debuggen von Azure-API-Verwaltungsrichtlinien (verfügbar in der Entwicklerdienstebene)
• Verwenden von benannten Werten in Azure API Management-Richtlinien