Importieren von SAP OData-Metadaten als API

GILT FÜR: Alle API Management-Ebenen

In diesem Artikel wird beschrieben, wie Sie einen OData-Dienst (Open Data Protocol) mithilfe von OData-Metadaten in azure API Management importieren. Im folgenden Beispiel wird SAP Gateway Foundation verwendet.

In diesem Artikel erfahren Sie, wie Sie:

  • Abrufen von OData-Metadaten aus Ihrem SAP-Dienst
  • Importieren von OData-Metadaten in Azure API Management, entweder direkt oder nach der Konvertierung in eine OpenAPI-Spezifikation
  • Vollständige API-Konfiguration
  • Testen der API im Azure-Portal

Voraussetzungen

  • Erstellen Sie eine API-Verwaltungsinstanz.

  • Ein SAP-System und ein Dienst, das als OData v2 oder v4 verfügbar gemacht wird.

  • Wenn Ihr SAP-Back-End ein selbstsigniertes Zertifikat verwendet (zum Testen), müssen Sie möglicherweise die Überprüfung der Vertrauenskette für SSL deaktivieren. Konfigurieren Sie dazu ein Back-End in Ihrer API Management-Instanz:

    1. Wählen Sie im Azure-Portal unter APIsBackends>+Neues Backend erstellen aus.
    2. Fügen Sie eine benutzerdefinierte URL hinzu, die auf den SAP-Back-End-Dienst verweist.
    3. Erweitern Sie den Abschnitt "Erweitert ", und deaktivieren Sie dann die Kontrollkästchen " Zertifikatkette überprüfen " und "Zertifikatnamen überprüfen ".

    Hinweis

    Verwenden Sie in Produktionsszenarien die richtigen Zertifikate für die End-to-End-SSL-Überprüfung.

    Tipp

    Konvertieren Sie für den vollständigen Funktionsumfang der API-Verwaltung die SAP OData-API in die OpenAPI-Spezifikation, bevor Sie sich registrieren.

Abrufen von OData-Metadaten aus Ihrem SAP-Dienst

Verwenden Sie eine der folgenden Methoden, um Metadaten-XML aus Ihrem SAP-Dienst abzurufen. Wenn Sie planen, die Metadaten-XML in eine OpenAPI-Spezifikation zu konvertieren, speichern Sie die Datei lokal.

  • Verwenden Sie den SAP-Gatewayclient (Transaktion /IWFND/GW_CLIENT).
  • Führen Sie einen direkten HTTP-Aufruf aus, um den XML-Code abzurufen: http://<OData server URL>:<port>/<path>/$metadata.
  • Verwenden Sie ggf. den SAP Business Accelerator Hub .

Navigieren zur API Management-Instanz

  1. Suchen Sie im Azure-Portal nach API-Verwaltungsdiensten, und wählen Sie sie aus:

    Screenshot der API-Verwaltungsdienste in den Suchergebnissen.

  2. Wählen Sie auf der Seite "API-Verwaltungsdienste " Ihre API-Verwaltungsinstanz aus:

    Screenshot einer API-Verwaltungsinstanz auf der Seite

Importieren einer API in die API-Verwaltung

Wählen Sie eine der folgenden Methoden aus, um Ihre API in die API-Verwaltung zu importieren:

  • Konvertieren Sie die Metadaten-XML in eine OpenAPI-Spezifikation (empfohlen).
  • Importieren Sie die Metadaten-XML als OData-API direkt.

Konvertieren von OData-Metadaten in OpenAPI-JSON

  1. Verwenden Sie den Microsoft-Konverter, der auf dem Open-Source-Tool OASIS basiert.

    Im folgenden Beispiel wird OData v2-XML für den Testdienst epm_ref_apps_prod_man_srvkonvertiert:

    oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json

    Hinweis

    Zum Testen mit einer einzelnen XML-Datei können Sie die webbasierte Oberfläche verwenden.

  2. Speichern Sie die openapi-spec.json Datei lokal für den Import in die API-Verwaltung.

OpenAPI-Spezifikation importieren

  1. Wählen Sie im Randleistenmenü im Abschnitt APIs die Option APIs.

  2. Wählen Sie unter "Aus Definition erstellen" die OpenAPI-Kachel aus:

    Screenshot, der die OpenAPI-Kachel zeigt.

  3. Wählen Sie "Datei auswählen" und dann die openapi-spec.json Datei aus, die Sie lokal in einem vorherigen Schritt gespeichert haben.

  4. Geben Sie API-Einstellungen ein. Sie können diese Werte festlegen, wenn Sie die API importieren oder später konfigurieren, indem Sie zur Registerkarte "Einstellungen " wechseln.

  5. Wählen Sie "Erstellen" aus.

Außerdem müssen Sie die Authentifizierung für Ihr Back-End mithilfe einer geeigneten Methode für Ihre Umgebung konfigurieren. Beispiele finden Sie unter Authentifizierung und Autorisierung.

Hinweis

Informationen zu API-Importbeschränkungen finden Sie unter API-Importeinschränkungen und bekannte Probleme.

Testen der API

  1. Navigieren Sie zu Ihrer API Management-Instanz.

  2. Wählen Sie im Randleistenmenü APIs>aus.

  3. Wählen Sie unter Alle APIs Ihre importierte API aus.

  4. Wählen Sie die Registerkarte Test aus, um auf die Testkonsole zuzugreifen.

  5. Wählen Sie einen Vorgang aus, geben Sie alle erforderlichen Werte ein, und wählen Sie dann "Senden" aus.

    Testen Sie den GET /$metadata Aufruf, um die Konnektivität mit dem SAP-Backend zu überprüfen, zum Beispiel.

  6. Zeigen Sie die Antwort an. Zum Beheben von Problemen verfolgen Sie den Anruf.

  7. Wenn Sie mit dem Testen fertig sind, beenden Sie die Testkonsole.

Produktionsüberlegungen

Verwandte Inhalte

  • Last updated on