Teilen über


Importieren der SOAP-API in API Management

GILT FÜR: Alle API Management-Ebenen

Dieser Artikel zeigt, wie Sie eine WSDL-Spezifikation (eine standardmäßige XML-Darstellung einer SOAP-API) importieren. Der Artikel zeigt außerdem, wie Sie die API in API Management testen.

In diesem Artikel werden folgende Vorgehensweisen behandelt:

  • Importieren einer SOAP-API
  • Testen der API im Azure-Portal

Hinweis

Der WSDL-Import in API Management unterliegt bestimmten Einschränkungen. WSDL-Dateien mit den Anweisungen wsdl:import, xsd:import und xsd:include werden nicht unterstützt. Ein Open-Source-Tool zum Auflösen und Zusammenführen dieser Abhängigkeiten in einer WSDL-Datei finden Sie in diesem GitHub-Repository.

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. Wählen Sie unter Create from definition (Aus Definition erstellen) die Option WSDL aus.

    SOAP-API

  4. Geben Sie unter WSDL-Spezifikation die URL zu Ihrer SOAP-API ein, oder klicken Sie auf Datei auswählen, um eine lokale WSDL-Datei auszuwählen.

  5. Unter Importmethode ist standardmäßig SOAP-Passthrough ausgewählt. Bei dieser Auswahl wird die API als SOAP verfügbar gemacht, und API-Consumer müssen SOAP-Regeln verwenden. Wenn Sie die API „korrigieren“ möchten, führen Sie die Schritte in Importieren einer SOAP-API und Konvertieren dieser in REST aus.

    Erstellen einer SOAP-API aus der WSDL-Spezifikation

  6. Die folgenden API-Einstellungen werden automatisch anhand der Informationen aus der SOAP-API aufgefüllt: Anzeigename, Name, Beschreibung. Vorgänge werden automatisch mit Anzeigename, URL und Beschreibung ausgefüllt und erhalten einen vom System generierten Namen.

  7. Geben Sie weitere API-Einstellungen ein. Sie können die Werte während der Erstellung festlegen oder später über die Registerkarte Einstellungen konfigurieren.

    Weitere Informationen zu API-Einstellungen finden Sie im Tutorial Importieren und Veröffentlichen Ihrer ersten API.

  8. 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 der Test erfolgreich ist, antwortet das Back-End mit einem erfolgreichen HTTP-Antwortcode und einigen Daten.

    Tipp

    Standardmäßig sendet die Testkonsole eine Anforderung an den CORS-Proxy von API Management, der die Anforderung an die API Management-Instanz weiterleitet, die sie dann an das Back-End weiterleitet. Dieser Proxy verwendet die öffentliche IP-Adresse 13.91.254.72 und kann nur öffentliche Endpunkte erreichen. Wenn Sie eine Anforderung direkt vom Browser an den API Management-Dienst senden möchten, wählen Sie CORS-Proxy umgehen aus. Verwenden Sie diese Option, wenn Sie die Testkonsole verwenden möchten und Ihr API Management-Gateway vom Netzwerk isoliert ist oder keinen Datenverkehr vom CORS-Proxy zulässt.

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

SOAP-Platzhalteraktion

Wenn Sie eine SOAP-Anforderung übergeben müssen, für die in der API keine dedizierte Aktion definiert ist, können Sie eine SOAP-Platzhalteraktion konfigurieren. Die Platzhalteraktion stimmt mit jeder SOAP-Anforderung überein, die nicht in der API definiert ist.

So definieren Sie eine SOAP-Platzhalteraktion:

  1. Wählen Sie im Portal die API aus, die Sie im vorherigen Schritt erstellt haben.
  2. Wählen Sie auf der Registerkarte Entwurf die Option + Vorgang hinzufügen aus.
  3. Geben Sie einen Anzeigenamen für den Vorgang ein.
  4. Wählen Sie unter URL die Option POST aus, und geben Sie in der Ressource /soapAction={any} ein. Der Vorlagenparameter in den eckigen Klammern ist willkürlich festgelegt und wirkt sich nicht auf die Ausführung aus.

Anfügen weiterer APIs

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

  • Eine OpenAPI-Spezifikation
  • SOAP-API
  • Eine GraphQL-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