Importieren von SAP OData-Metadaten als API

  • Artikel

GILT FÜR: Alle API Management-Ebenen

In diesem Artikel wird gezeigt, wie Sie einen OData-Dienst mithilfe seiner Metadatenbeschreibung importieren. In diesem Artikel dient SAP Gateway Foundation als Beispiel.

In diesem Artikel führen Sie Folgendes durch:

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

Hinweis

Das Importieren einer OData-API in API Management aus der Metadatenbeschreibung befindet sich in der Vorschau. Weitere Informationen

Voraussetzungen

  • Eine bestehende API Management-Instanz. Erstellen Sie eine, falls nicht schon geschehen.

  • Ein SAP-System und -Dienst, die als OData v2 oder v4 verfügbar gemacht sind.

  • Wenn Ihr SAP-Back-End ein selbstsigniertes Zertifikat verwendet (zu Testzwecken), 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 APIs die Option Back-Ends>+ Hinzufügen aus.
    2. Fügen Sie eine benutzerdefinierte URL hinzu, die auf den SAP-Back-End-Dienst verweist.
    3. Deaktivieren Sie die Optionen Validate certificate chain (Zertifikatkette überprüfen) und Validate certificate name (Zertifikatnamen überprüfen).

    Hinweis

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

Abrufen von OData-Metadaten aus Ihrem SAP-Dienst

Rufen Sie die Metadaten-XML aus Ihrem SAP-Dienst mithilfe einer der folgenden Methoden ab. Wenn Sie planen, die Metadaten-XML in eine OpenAPI-Spezifikation zu konvertieren, speichern Sie die Datei lokal.

  • Verwenden Sie den SAP Gateway-Client (Transaktion /IWFND/GW_CLIENT), oder
  • Führen Sie einen direkten HTTP-Aufruf aus, um die XML abzurufen: http://<OData server URL>:<port>/<path>/$metadata

Navigieren zur API Management-Instanz

  1. Suchen Sie im Azure-Portal nach API Management-Dienste, und wählen Sie diese Option aus.

    Auswählen von API Management-Dienste

  2. Wählen Sie auf der Seite API Management-Dienste Ihre API Management-Instanz aus.

    Auswählen Ihrer API Management-Instanz

Importieren der API in API Management

Wählen Sie eine der folgenden Methoden aus, um Ihre API in API Management zu importieren: Importieren Sie die Metadaten-XML direkt als OData-API, oder konvertieren Sie die Metadaten-XML in eine OpenAPI-Spezifikation.

Importieren von OData-Metadaten

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

  2. Wählen Sie unter Aus Definition erstellen die Option OData aus.

    Screenshot: Erstellen einer API aus einer OData-Beschreibung im Portal.

  3. Geben Sie API-Einstellungen ein. Sie können Ihre Einstellungen später aktualisieren, indem Sie zur Registerkarte Einstellungen der API wechseln.

    1. Geben Sie in der OData-Spezifikation eine URL für einen OData-Metadatenendpunkt ein. Das ist in der Regel die URL zum Dienststamm, die mit „/$metadata“ angefügt wird. Alternativ können Sie eine lokale OData-XML-Datei zum Importieren auswählen.

    2. Geben Sie die verbleibenden Einstellungen ein, um Ihre API zu konfigurieren. Diese Einstellungen werden im Tutorial Importieren und Veröffentlichen Ihrer ersten API erläutert.

  4. Klicken Sie auf Erstellen.

    Die API wird der Liste APIs hinzugefügt. Die Entitätssätze und Funktionen, die in der OData-Metadatenbeschreibung verfügbar gemacht werden, werden auf der Registerkarte Entitätenmenge und Funktionen der API angezeigt.

    Screenshot der OData-Entitätssätze und -Funktionen im Portal.

Aktualisieren des OData-Schemas

Sie können auf einen Editor im Portal zugreifen, um das OData-Schema Ihrer API anzuzeigen. Wenn sich die API ändert, können Sie das Schema in API Management auch aus einer Datei oder einem OData-Dienstendpunkt aktualisieren.

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

  2. Wählen Sie im linken Menü APIs> Ihre OData-API aus.

  3. Wählen Sie auf der Registerkarte Entitätssätze und Funktionen das Kontextmenü (...) neben einem Entitätssatz oder einer Funktion aus, und wählen Sie Bearbeiten aus.

    Screenshot des Kontextmenüs für eine im Portal festgelegte OData-Entitätenmenge.

  4. Überprüfen Sie das Schema. Wenn Sie es aktualisieren möchten, wählen Sie Aus Datei aktualisieren oder Schema vom Endpunkt aktualisieren aus.

    Screenshot des Schema-Editors der OData-API im Portal.

Testen der OData-API

  1. Wählen Sie im linken Menü APIs> Ihre OData-API aus.

  2. Wählen Sie auf der Registerkarte Entitätssätze und Funktionen das Kontextmenü (...) neben einem Entitätssatz oder einer Funktion aus, und wählen Sie Testen aus.

    Screenshot der Option „Testen“ im Kontextmenü für eine im Portal festgelegte OData-Entitätenmenge.

  3. Geben Sie in der Testkonsole Vorlagenparameter, Abfrageparameter und Header für Ihren Test ein, und wählen Sie Testen aus. Erfahren Sie mehr über das Testen einer API im Portal.

Schützen Ihrer OData-API

Schützen Sie Ihre OData-API, indem Sie sowohl vorhandene Authentifizierungs- und Autorisierungsrichtlinien als auch eine OData-Validierungsrichtlinie anwenden, um sich gegen Angriffe durch OData-API-Anforderungen abzusichern.

Tipp

Konfigurieren Sie im Portal auf der Registerkarte API-Richtlinien Richtlinien für Ihre OData-API.

Produktionsüberlegungen