Partager via


Appeler vos propres API web et API REST à partir de flux de travail dans Azure Logic Apps

S’applique à : Azure Logic Apps (Consommation + Standard)

Lorsque vous disposez d’API web ou d’API REST existantes que vous souhaitez appeler à partir de flux de travail dans Azure Logic Apps, vous devez d’abord effectuer certaines étapes de configuration avant de pouvoir appeler ces API. Principalement, vous devez déployer vos API en tant qu’applications web ou applications API. Vous pouvez effectuer cette tâche en hébergeant vos API sur Azure App Service, une plateforme cloud qui fournit un hébergement d’API hautement évolutif et facile.

Dans App Service, vous pouvez déployer vos API en tant qu’applications web, mais envisagez de déployer vos API en tant qu’applications API à la place. Cette approche facilite votre travail lorsque vous créez, hébergez et consommez des API dans le cloud et dans des environnements locaux. Vous n’avez pas besoin de modifier le code de vos API pour le déployer sur une application API.

Vous pouvez appeler n’importe quelle API à partir d’un flux de travail, mais pour une expérience optimale, ajoutez des métadonnées Swagger à votre application web ou application API. Ce document Swagger décrit vos opérations et paramètres d’API, ce qui permet aux workflows d’application logique de fonctionner mieux et plus facilement avec votre API. Vous devez également configurer le partage de ressources cross-origin (CORS) sur votre application web ou application API afin que votre flux de travail puisse accéder à votre API.

Ce guide montre comment ajouter un document Swagger, configurer CORS pour votre application web ou votre application API, et fournir des options d’appel de votre API à partir d’un flux de travail après avoir terminé le déploiement et l’hébergement de votre API dans App Service.

Pour plus d’informations, consultez :

Prerequisites

Ajouter l’accès Swagger et CORS à votre application web ou application API

Lorsque vous ajoutez un document Swagger à votre application web ou application API, le concepteur de flux de travail dans Azure Logic Apps peut plus facilement trouver et afficher les opérations et paramètres disponibles dans votre API. Vous devez également configurer le partage de ressources cross-origin (CORS) sur votre application web ou application API afin que votre flux de travail puisse accéder à votre API.

Pour rendre votre document Swagger lisible à partir de votre flux de travail dans le concepteur, sur votre application web ou application API, définissez les propriétés de définition de l’API et l’accès CORS.

  1. Dans le portail Azure, recherchez et ouvrez votre application web ou ressource d’application API.

  2. Dans la barre latérale des ressources de l’application, sélectionnez Vue d’ensemble.

  3. Sous l’onglet Propriétés , sous Domaines, à partir de la propriété de domaine par défaut , copiez et enregistrez le nom du site web quelque part pour l’étape suivante.

  4. Dans la barre latérale des ressources de l’application, sous API, sélectionnez définition d’API. Pour l’emplacement de définition d’API, entrez l’URL de votre fichier JSON Swagger, qui utilise généralement le format suivant, mais peut différer si votre fichier Swagger utilise une spécification d’API plus récente :

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

    L’exemple suivant montre une URL Swagger avec la spécification d’API la plus récente :

    Capture d’écran montrant le portail Azure, la page de définition d’API de l’application web et l’URL du document Swagger de votre API.

  5. Lorsque vous avez terminé, sélectionnez Enregistrer.

  6. Dans la barre latérale des ressources de l’application, sous API, sélectionnez CORS.

  7. Pour l’origine autorisée, définissez la stratégie CORS sur « * », ce qui signifie autoriser tout.

    Ce paramètre autorise les demandes du concepteur de flux de travail dans Azure Logic Apps.

    Capture d’écran montrant le volet CORS de l’application web avec les origines autorisées définie sur *, ce qui autorise tout.

  8. Dans la barre d’outils, sélectionnez Enregistrer.

Pour plus d’informations, consultez Héberger une API RESTful avec CORS dans Azure App Service.

Appeler votre API à partir de votre workflow

Une fois que vous avez configuré l’URL de définition d’API et CORS, vos opérations d’API apparaissent dans la galerie de connecteurs pour vous permettre de trouver et d’ajouter à votre flux de travail.

  • Pour afficher les sites web qui ont des URL OpenAPI, vous pouvez parcourir vos sites web d’abonnement dans le concepteur de flux de travail.

  • Pour afficher les actions et entrées disponibles en pointant sur un document Swagger, utilisez le déclencheur ou l’action HTTP + Swagger .

  • Pour appeler n’importe quelle API, y compris les API qui n’ont pas ou n’exposent pas de document Swagger, vous pouvez toujours créer une requête avec l’action HTTP.