Freigeben über

Manuelles Hinzufügen einer API

GILT FÜR: Alle API Management-Ebenen

In diesem Artikel wird beschrieben, wie Sie eine API manuell zur Azure-API-Verwaltung hinzufügen. Wenn Sie simulierte Antworten aus der API erstellen möchten, können Sie eine leere API erstellen. Informationen zum Erstellen simulierter API-Antworten finden Sie unter Mock-API-Antworten.

Wenn Sie eine vorhandene API importieren möchten, lesen Sie den Abschnitt "Verwandter Inhalt " in diesem Artikel.

In diesem Artikel erfahren Sie, wie Sie eine leere API erstellen. Sie geben httpbin.org (einen öffentlichen Testdienst) als Back-End-API an.

Voraussetzungen

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

Erstellen einer API

  1. Wählen Sie unter APIs im linken Menü APIs aus.

  2. Wählen Sie + API hinzufügen aus.

  3. Wählen Sie die HTTP-Kachel aus:

    Screenshot der HTTP-Kachel im Azure-Portal.

  4. Geben Sie die Back-End-Webdienst-URL (z. B https://httpbin.org) und andere Einstellungen für die API ein. Die Einstellungen werden im Tutorial Importieren und Veröffentlichen Ihrer ersten API erläutert.

  5. Klicken Sie auf Erstellen.

Zu diesem Zeitpunkt enthält API Management noch keine Vorgänge, die Vorgängen in Ihrer Back-End-API zugeordnet sind. Wenn Sie einen Vorgang aufrufen, der über das Back-End, aber nicht über die API-Verwaltung verfügbar gemacht wird, erhalten Sie einen Fehler von 404.

Hinweis

Wenn Sie eine API hinzufügen, auch wenn sie mit einem Back-End-Dienst verbunden ist, macht die API-Verwaltung standardmäßig keine Vorgänge verfügbar, bis Sie sie zulassen. Um einen Vorgang Ihres Back-End-Diensts zuzulassen, erstellen Sie einen API Management-Vorgang, der dem Back-End-Vorgang zugeordnet ist.

Hinzufügen und Testen von Vorgängen

In diesem Abschnitt wird gezeigt, wie Sie einen /get Vorgang hinzufügen, um ihn dem Back-End-Vorgang http://httpbin.org/get zuzuordnen.

Hinzufügen eines Vorgangs

  1. Wählen Sie die API aus, die Sie im vorherigen Schritt erstellt haben.
  2. Wählen Sie + Vorgang hinzufügen.
  3. Wählen Sie in der URLGET aus, und geben Sie "/get " in das Textfeld ein.
  4. Geben Sie "FetchData" in "Anzeigename" ein.
  5. Wählen Sie Speichern aus.

Testen des Vorgangs

Testen Sie den Vorgang im Azure-Portal. (Sie können es auch im Entwicklerportal testen.)

  1. Wählen Sie die Registerkarte Testen aus.
  2. Wählen Sie FetchData aus.
  3. Wählen Sie "Senden" aus.

Die Antwort, die der http://httpbin.org/get Vorgang generiert, wird im HTTP-Antwortabschnitt angezeigt. Wenn Sie Ihre Vorgänge transformieren möchten, lesen Sie unter Transformieren und Schützten Ihrer API nach.

Hinzufügen und Testen parametrisierter Vorgänge

In diesem Abschnitt wird gezeigt, wie Sie einen Vorgang hinzufügen, der einen Parameter akzeptiert. In diesem Beispiel ordnen Sie den Vorgang zu http://httpbin.org/status/200.

Hinzufügen eines Vorgangs

  1. Wählen Sie die API aus, die Sie zuvor erstellt haben.
  2. Wählen Sie auf der Registerkarte Entwurf die Option + Vorgang hinzufügen aus.
  3. Wählen Sie in der URLGET aus, und geben Sie im Textfeld "/status/{code} " ein.
  4. Geben Sie "GetStatus" in "Anzeigename" ein.
  5. Wählen Sie Speichern aus.

Testen des Vorgangs

Testen Sie den Vorgang im Azure-Portal. (Sie können es auch im Entwicklerportal testen.)

  1. Wählen Sie die Registerkarte Testen aus.

  2. Wählen Sie GetStatus aus. Geben Sie im Code200 ein.

  3. Wählen Sie "Senden" aus.

    Die Antwort, die der http://httpbin.org/status/200 Vorgang generiert, wird im HTTP-Antwortabschnitt angezeigt. Wenn Sie Ihre Vorgänge transformieren möchten, lesen Sie unter Transformieren und Schützten Ihrer API nach.

Hinzufügen und Testen eines Platzhaltervorgangs

In diesem Abschnitt wird gezeigt, wie Sie einen Platzhaltervorgang hinzufügen. Mit einem Wildcard-Vorgang können Sie einen beliebigen Wert mit einer API-Anforderung übergeben. Anstatt separate GET-Vorgänge zu erstellen wie in den vorherigen Abschnitten gezeigt, können Sie einen GET-Platzhaltervorgang erstellen.

Achtung

Seien Sie vorsichtig, wenn Sie einen Wildcardvorgang konfigurieren. Diese Konfiguration macht eine API möglicherweise anfälliger für bestimmte API-Sicherheitsbedrohungen.

Hinzufügen eines Vorgangs

  1. Wählen Sie die API aus, die Sie zuvor erstellt haben.
  2. Wählen Sie auf der Registerkarte Entwurf die Option + Vorgang hinzufügen aus.
  3. Wählen Sie in der URLGET aus, und geben Sie /* in das Textfeld ein.
  4. Geben Sie im Anzeigenamen"WildcardGet" ein.
  5. Wählen Sie Speichern aus.

Testen des Vorgangs

Testen Sie den Vorgang im Azure-Portal. (Sie können es auch im Entwicklerportal testen.)

  1. Wählen Sie die Registerkarte Testen aus.

  2. Wählen Sie WildcardGet aus. Probieren Sie die GET-Vorgänge aus, die Sie in den vorherigen Abschnitten getestet haben, oder probieren Sie einen anderen unterstützten GET-Vorgang aus.

    Ändern Sie beispielsweise unter Vorlagenparameter den Wert neben dem Platzhalternamen (*) in headers. Der Vorgang gibt die HTTP-Header der eingehenden Anforderung zurück.

  3. Wählen Sie "Senden" aus.

    Die Antwort, die der http://httpbin.org/headers Vorgang generiert, wird im HTTP-Antwortabschnitt angezeigt. Wenn Sie Ihre Vorgänge transformieren möchten, lesen Sie unter Transformieren und Schützten Ihrer API nach.

Hinweis

Möglicherweise ist es wichtig, zu verstehen, wie der Host für die Back-End-API, die Sie für die Integration nutzen, nachgestellte Schrägstriche für eine Vorgangs-URL verarbeitet. Weitere Informationen finden Sie im FAQ zu API Management.

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