Importieren einer OData-API

  • Artikel

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
  • Schützen der 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 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 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.

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