Importieren von SAP OData-Metadaten als API

GILT FÜR: Alle API Management-Ebenen

In diesem Artikel wird beschrieben, wie Sie einen OData-Dienst mithilfe der Metadatenbeschreibung importieren. SAP Gateway Foundation wird als Beispiel verwendet.

In diesem Artikel führen Sie folgende Schritte aus:

• 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

• Eine API Management-Instanz. Wenn Sie nicht über einen verfügen, führen Sie die Schritte unter Erstellen einer API-Verwaltungsinstanz mithilfe des Azure-Portals aus.

• 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 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 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.

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).
  oder
• Führen Sie einen direkten HTTP-Aufruf aus, um den XML-Code 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 die entsprechende Option aus:

   

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

   

Importieren einer API in die API-Verwaltung

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

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

OData-Metadaten

Importieren von OData-Metadaten

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

2. Wählen Sie unter "Aus Definition erstellen" OData aus:

   

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. Dieser Wert ist in der Regel die URL zum Dienststamm, angefügt mit /$metadata. Alternativ können Sie eine lokale OData-XML-Datei zum Importieren auswählen.

   2. Geben Sie zusätzliche 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 der 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.

   

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 und dann Ihre OData-API aus.

3. Wählen Sie auf der Registerkarte "Entitätssätze und Funktionen " die Auslassungspunkte (...) neben einem Entitätssatz oder einer Funktion aus, und wählen Sie dann "Bearbeiten" aus.

   

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

   

Testen der OData-API

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

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

   

3. Geben Sie in der Testkonsole Vorlagenparameter, Abfrageparameter und Header für Ihren Test ein, und wählen Sie dann "Testen" aus. Weitere Informationen zum Testen von APIs im Portal finden Sie unter Testen der neuen API im Portal.

Schützen Sie Ihre OData-API

Sichern Sie Ihre OData-API, indem Sie vorhandene Authentifizierungs- und Autorisierungsrichtlinien und eine OData-Validierungsrichtlinie anwenden, um vor Angriffen über OData-API-Anforderungen zu schützen.

Tipp

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

OpenAPI-Spezifikation

Konvertieren von OData-Metadaten in OpenAPI-JSON

1. Konvertieren Sie den OData-XML-Code in das OpenAPI-JSON-Format. Verwenden Sie je nach Metadaten-XML ein OASIS-Open-Source-Tool für OData v2 oder OData v4.

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

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Hinweis

   • Zum Testen mit einer einzelnen XML-Datei können Sie einen webbasierten Konverter verwenden, der auf einem Open-Source-Tool basiert.
   • Mit dem Tool oder dem webbasierten Konverter ist die Angabe von <IP-Adresse>:<Port> Ihres SAP OData-Servers optional. Alternativ können Sie diese Informationen später in der generierten OpenAPI-Spezifikation oder nach dem Importieren der Datei in die API-Verwaltung hinzufügen.

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

OpenAPI-Spezifikation importieren

1. Wählen Sie im linken Navigationsbereich im Abschnitt APIs die Option APIs aus.

2. Wählen Sie unter "Neue Definition erstellen" die Option "OpenAPI" aus:

   

3. Klicken Sie auf "Datei auswählen", und wählen Sie 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.

   • Für das API-URL-Suffix empfehlen wir die Verwendung desselben URL-Pfads wie der des ursprünglichen SAP-Diensts.

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

5. Klicken Sie auf Erstellen.

Hinweis

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

Abschließen der API-Konfiguration

Fügen Sie die folgenden drei Vorgänge zu der API hinzu, die Sie importiert haben:

• GET /$metadata

  Vorgang	BESCHREIBUNG	Zusätzliche Konfiguration für den Vorgang
  GET /$metadata	Ermöglicht API Management, den $metadata-Endpunkt zu erreichen, der für die Clientintegration in den OData-Server erforderlich ist. Dieser erforderliche Vorgang ist nicht in der OpenAPI-Spezifikation enthalten, die Sie generiert und importiert haben.	Fügen Sie eine 200 OK-Antwort hinzu.

  

• HEAD /

  Vorgang	BESCHREIBUNG
  HEAD /	Ermöglicht dem Client bei Bedarf den Austausch von CSRF-Token (Cross-Site Request Forgery, siteübergreifende Anforderungsfälschung) mit dem SAP-Server. SAP ermöglicht auch den CSRF-Tokenaustausch über das GET-Verb. Der CSRF-Tokenaustausch wird in diesem Artikel nicht behandelt. Sehen Sie sich einen Beispiel-API-Verwaltungsrichtlinienausschnitt zum Brokertokenaustausch an.

  

• GET /

  Vorgang	BESCHREIBUNG	Zusätzliche Konfiguration für den Vorgang
  GET /	Aktiviert die Richtlinienkonfiguration im Dienststammverzeichnis.	Konfigurieren Sie die folgende Richtlinie für einen eingehenden Rewrite-URI (URI für das Umschreiben), um an Anforderungen, die an das Dienststammverzeichnis weitergeleitet werden, einen nachstehenden Schrägstrich anzufügen: <rewrite-uri template="/" copy-unmatched-params="true" /> Diese Richtlinie entfernt potenzielle Mehrdeutigkeit zwischen Anfragen mit und ohne nachstehende Schrägstriche. Diese beiden Arten von Anforderungen werden von einigen Back-Ends unterschiedlich behandelt.

  

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

Testen der API

1. Navigieren Sie zu Ihrer API Management-Instanz.

2. Wählen Sie im linken Navigationsbereich im Abschnitt APIs die Option 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

• Ein Beispiel für ein End-to-End-Szenario für die Integration der API-Verwaltung in ein SAP-Gateway finden Sie in diesem Beispiel.
• Steuern des Zugriffs auf ein SAP-Back-End mithilfe von API-Verwaltungsrichtlinien. Wenn die API beispielsweise als OData-API importiert wird, verwenden Sie die Richtlinie zum Überprüfen der OData-Anforderung. Es gibt auch Richtlinienausschnitte für die SAP-Prinzipalverteilung für SAP ECC oder S/4HANA oder SAP SuccessFactors und das Abrufen eines X-CSRF-Tokens.
• Anleitungen zum Bereitstellen, Verwalten und Migrieren von APIs im großen Maßstab finden Sie unter:
  • Automatisierte API-Bereitstellungen mit APIOps.
  • CI/CD für API Management mittels Azure Resource Manager-Vorlagen.

Verwandte Inhalte

• Einschränkungen beim API-Import
• Importieren einer OpenAPI-Spezifikation
• Importieren einer SOAP-API
• Importieren einer SOAP-API und Konvertieren in REST
• Importieren einer App Service-API
• Importieren einer Container-App-API
• Importieren einer WebSocket-API
• Importieren einer GraphQL-API
• Importieren eines GraphQL-Schemas und Einrichten von Feldauflösern
• Importieren einer Funktions-App-API
• Importieren einer Logik-App-API
• Importieren Sie einen Service Fabric-Dienst
• Importieren einer Azure AI Foundry-API
• Importieren einer Azure OpenAI-API
• Importieren einer LLM-API
• Importieren einer OData-API
• Importieren von SAP OData-Metadaten
• Importieren einer gRPC-API
• Bearbeiten von APIs