Importieren einer OpenAPI-Spezifikation

In diesem Artikel erfahren Sie, wie Sie eine Back-End-API vom Typ „OpenAPI-Spezifikation“ aus https://conferenceapi.azurewebsites.net?format=json importieren. Diese Back-End-API wird von Microsoft bereitgestellt und in Azure gehostet. Der Artikel zeigt außerdem, wie Sie die APIM-API testen.

In diesem Artikel werden folgende Vorgehensweisen behandelt:

  • Importieren einer OpenAPI-Spezifikation über das Azure-Portal, die Azure CLI oder Azure PowerShell
  • Testen der API im Azure-Portal

Hinweis

API-Importeinschränkungen sind unter API-Importeinschränkungen und bekannte Probleme dokumentiert.

Voraussetzungen

Importieren einer Back-End-API

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

  2. Wählen Sie im linken Menü APIs> + API hinzufügen aus.

  3. Klicken Sie unter Create from definition (Aus Definition erstellen) auf OpenAPI.

    Screenshot: Erstellen einer API aus einer OpenAPI-Spezifikation im Portal

  4. Geben Sie API-Einstellungen ein. Sie können die Werte während der Erstellung festlegen oder später über die Registerkarte Einstellungen konfigurieren. Die Einstellungen werden im Tutorial Importieren und Veröffentlichen Ihrer ersten API erläutert.

  5. Klicken Sie auf Erstellen.

Testen der neuen API im Portal

Vorgänge können direkt aus dem Portal aufgerufen werden. Dies ist für Administratoren eine einfache Möglichkeit, die Vorgänge einer API anzuzeigen und zu testen.

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

  2. Wählen Sie die Registerkarte Testen aus.

  3. Wählen Sie einen Vorgang aus.

    Die Seite zeigt Felder für Abfrageparameter und Felder für die Header.

    Hinweis

    In der Testkonsole füllt API Management automatisch einen Ocp-Apim-Subscription-Key-Header auf und konfiguriert den Abonnementschlüssel des integrierten All-Access-Abonnements. Dieser Schlüssel ermöglicht den Zugriff auf jede API in der API Management-Instanz. Optional können Sie den Ocp-Apim-Subscription-Key-Header anzeigen, indem Sie das Augensymbol neben der HTTP-Anforderung auswählen.

  4. Geben Sie je nach Vorgang Abfrageparameterwerte, Headerwerte oder einen Anforderungstext ein. Wählen Sie Senden aus.

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

Informationen zum Debuggen einer API finden Sie unter Tutorial: Debuggen von APIs mit der Anforderungsablaufverfolgung.

Anfügen weiterer APIs

Sie können eine API aus APIs zusammensetzen, die von verschiedenen Diensten verfügbar gemacht werden, u. a.:

  • OpenAPI-Spezifikation
  • SOAP-API
  • In Azure App Service gehostete Web-App
  • Azure-Funktionen-App
  • Azure Logic Apps
  • Azure Service Fabric

Führen Sie zum Anfügen einer anderen API an eine vorhandene API die folgenden Schritte aus.

Hinweis

Wenn Sie eine andere API importieren, werden die Vorgänge an Ihre aktuelle API angefügt.

  1. Navigieren Sie im Azure-Portal zu Ihrer Azure API Management-Instanz.

    Navigieren zur Azure API Management-Instanz

  2. Wählen Sie auf der Seite Übersicht oder im Menü auf der linken Seite die Option APIs aus.

    Auswählen von „APIs“

  3. Klicken Sie neben der API, die Sie an eine andere API anfügen möchten, auf ....

  4. Wählen Sie im Dropdownmenü Importieren aus.

    Auswählen von „Importieren“

  5. Wählen Sie einen Dienst aus, aus dem eine API importiert werden soll.

    Auswählen des Diensts

Nächste Schritte