Freigeben über

Importieren einer OData-API

GILT FÜR: Alle API Management-Ebenen

In diesem Artikel wird gezeigt, wie Sie einen mit OData kompatiblen Dienst als API in API Management importieren.

In diesem Artikel werden folgende Vorgehensweisen behandelt:

  • Importieren einer OData-Metadatenbeschreibung mithilfe des Azure-Portals
  • Verwalten des OData-Schemas im Portal
  • Sichern Sie die OData-API

Voraussetzungen

  • Eine API Management-Instanz. Falls Sie nicht bereits über einen API Management-Dienst verfügen, arbeiten Sie die folgende Schnellstartanleitung durch: Erstellen einer Azure API Management-Instanz.

  • Ein Dienst, der als OData v2 oder v4 verfügbar gemacht ist.

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 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:

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

    Screenshot, der OData-Entitätssätze und -Funktionen zeigt.

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.

    Screenshot, der den Speicherort des Befehls

  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 für eine OData-API.

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.

    Screenshot des Befehls

  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.

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

Anfügen weiterer APIs

Sie können eine API aus APIs erstellen, die von verschiedenen Diensten verfügbar gemacht werden, einschließlich:

  • Eine OpenAPI-Spezifikation
  • Eine SOAP-API
  • Eine GraphQL-API
  • Eine Web-App, die in Azure App Service gehostet wird
  • Azure-Funktionen
  • Azure Logic Apps
  • Azure Service Fabric

Hinweis

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

So fügen Sie eine API an eine vorhandene API an:

  1. Wechseln Sie im Azure-Portal zu Ihrer Azure-API-Verwaltungsinstanz:

    Screenshot der Seite

  2. Wählen Sie auf der Seite "Übersicht"APIs aus, oder wählen Sie im Menü auf der linken Seite APIs> aus.

    Screenshot der APIs-Auswahl auf der Seite

  3. Wählen Sie die Ellipse (...) neben der API aus, zu der Sie eine andere API hinzufügen möchten.

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

    Screenshot des Befehls

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

Verwandte Inhalte