Freigeben über


Aufrufen eigener Web-APIs und REST-APIs aus Workflows in Azure Logic Apps

Gilt für: Azure Logic Apps (Verbrauch + Standard)

Wenn Sie über vorhandene Web-APIs oder REST-APIs verfügen, die Sie aus Workflows in Azure Logic Apps aufrufen möchten, müssen Sie zunächst einige Setupschritte ausführen, bevor Sie diese APIs aufrufen können. In erster Linie müssen Sie Ihre APIs als Web-Apps oder API-Apps bereitstellen. Sie können diese Aufgabe ausführen, indem Sie Ihre APIs auf Azure App Service hosten, einer Cloudplattform, die hoch skalierbares, einfaches API-Hosting bietet.

In App Service können Sie Ihre APIs als Web-Apps bereitstellen, aber stattdessen die Bereitstellung Ihrer APIs als API-Apps in Betracht ziehen. Dieser Ansatz erleichtert Ihren Auftrag beim Erstellen, Hosten und Nutzen von APIs in der Cloud und in lokalen Umgebungen. Sie müssen keinen Code in Ihren APIs ändern, um sie in einer API-App bereitzustellen.

Sie können eine beliebige API aus einem Workflow aufrufen, aber um die beste Benutzererfahrung zu erzielen, fügen Sie Ihrer Web-App oder API-App Swagger-Metadaten hinzu. Dieses Swagger-Dokument beschreibt Ihre API-Vorgänge und -Parameter, wodurch Logik-App-Workflows mit Ihrer API besser und einfacher funktionieren. Sie müssen auch corS (Cross-Origin Resource Sharing) in Ihrer Web-App oder API-App einrichten, damit Ihr Workflow auf Ihre API zugreifen kann.

In diesem Leitfaden wird gezeigt, wie Sie ein Swagger-Dokument hinzufügen, CORS für Ihre Web-App oder API-App einrichten und Optionen zum Aufrufen Ihrer API aus einem Workflow bereitstellen, nachdem Sie die Bereitstellung und das Hosting für Ihre API in App Service abgeschlossen haben.

Weitere Informationen finden Sie unter:

Voraussetzungen

Hinzufügen von Swagger und CORS-Zugriff auf Ihre Web-App oder API-App

Wenn Sie Ihrer Web-App oder API-App ein Swagger-Dokument hinzufügen, kann der Workflow-Designer in Azure Logic Apps die verfügbaren Vorgänge und Parameter in Ihrer API einfacher finden und anzeigen. Sie müssen auch corS (Cross-Origin Resource Sharing) in Ihrer Web-App oder API-App einrichten, damit Ihr Workflow auf Ihre API zugreifen kann.

Damit Ihr Swagger-Dokument aus Ihrem Workflow im Designer lesbar ist, legen Sie in Ihrer Web-App oder API-App die API-Definitionseigenschaften und den CORS-Zugriff fest.

  1. Suchen und öffnen Sie im Azure-Portal Ihre Web-App- oder API-App-Ressource.

  2. Wählen Sie auf der App-Ressourcen-Randleiste die Option "Übersicht" aus.

  3. Kopieren Und speichern Sie auf der Registerkarte "Eigenschaften " unter "Domänen" aus der Standarddomäneneigenschaft den Websitenamen irgendwo für den nächsten Schritt.

  4. Wählen Sie auf der App-Ressourcen-Randleiste unter APIdie API-Definition aus. Geben Sie für den SPEICHERORT der API-Definition die URL für Ihre Swagger-JSON-Datei ein, die in der Regel das folgende Format verwendet, kann sich jedoch unterscheiden, wenn Ihre Swagger-Datei eine neuere API-Spezifikation verwendet:

    https://<website-name>/swagger/docs/v1

    Das folgende Beispiel zeigt eine Swagger-URL mit der neueren API-Spezifikation:

    Screenshot des Azure-Portals, der API-Definitionsseite von Web App und der URL für das Swagger-Dokument Ihrer API.

  5. Wenn Sie fertig sind, wählen Sie Speichern aus.

  6. Wählen Sie auf der App-Ressourcen-Randleiste unter APICORS aus.

  7. Legen Sie für zulässigen Ursprung die CORS-Richtlinie auf "*" fest, was bedeutet, dass alle zulässig sind.

    Diese Einstellung erlaubt Anforderungen vom Workflow-Designer in Azure Logic Apps.

    Screenshot des CORS-Bereichs der Web-App mit zulässigen Ursprüngen auf *, der alle zulässt.

  8. Wählen Sie auf der Symbolleiste Save (Speichern) aus.

Weitere Informationen finden Sie unter Hosten einer RESTful-API mit CORS in Azure App Service.

Aufrufen Ihrer API aus Ihrem Workflow

Nachdem Sie die API-Definitions-URL und CORS eingerichtet haben, werden Ihre API-Vorgänge im Connectorkatalog angezeigt, damit Sie ihren Workflow finden und hinzufügen können.

  • Um Websites mit OpenAPI-URLs anzuzeigen, können Sie Ihre Abonnementwebsites im Workflow-Designer durchsuchen.

  • Um verfügbare Aktionen und Eingaben anzuzeigen, indem Sie auf ein Swagger-Dokument zeigen, verwenden Sie den HTTP+Swagger-Trigger oder die Aktion.

  • Zum Aufrufen einer BELIEBIGEN API, einschließlich APIs, die kein Swagger-Dokument besitzen oder verfügbar machen, können Sie immer eine Anforderung mit der HTTP-Aktion erstellen.