Importer une application web Azure en tant qu’API

S'APPLIQUE À : Tous les niveaux de Gestion des API

Cet article explique comment utiliser le portail Azure pour importer une application web Azure en tant qu’API dans Gestion des API Azure et tester l’API importée.

Remarque

Cette fonctionnalité n’est actuellement pas disponible dans les espaces de travail.

Dans cet article, vous apprendrez comment :

Importer une application web, hébergée dans Azure App Service, en tant qu’API
Tester l’API dans le portail Azure

Exposer une application web à l’aide de gestion des API

Azure App Service est un service HTTP pour l’hébergement d’applications web, d’API REST et de back-ends mobiles. Les développeurs d’API peuvent utiliser leurs piles et pipelines technologiques préférés pour développer des API et publier leurs back-ends d’API en tant qu’applications web dans un environnement sécurisé et évolutif. Ils peuvent ensuite utiliser Gestion des API pour exposer les applications web, gérer et protéger les API tout au long de leur cycle de vie, et les publier auprès des consommateurs.

L’utilisation de Gestion des API pour exposer une API hébergée sur Web Apps offre les avantages suivants :

Dissociez la gestion et la sécurisation du front-end exposé aux consommateurs d’API de la gestion et de la supervision de l’application web principale.
Gérez les API web hébergées en tant qu’applications web dans le même environnement que vos autres API.
Appliquez des stratégies pour modifier le comportement de l’API, comme la limitation du taux d’appel.
Rediriger les consommateurs d'API vers le portail des développeurs Gestion des API personnalisables afin qu'ils puissent découvrir et apprendre à connaître vos API, demander l'accès et tester les API.

Pour plus d’informations, consultez En savoir plus sur Gestion des API.

Définition OpenAPI et opérations génériques

Gestion des API prend en charge l’importation d’applications web hébergées dans App Service qui incluent une définition OpenAPI (définition Swagger). Toutefois, une définition OpenAPI n’est pas nécessaire.

Si l’application web est configurée avec une définition OpenAPI, Gestion des API détecte cela. Vous pouvez également importer manuellement la définition dans Gestion des API. La Gestion des API crée ensuite des opérations d’API qui mappent directement à la définition, notamment les chemins d’accès, les paramètres et les types de réponse requis.

L’utilisation d’une définition OpenAPI est recommandée, car l’API est importée dans Gestion des API avec une haute fidélité, ce qui vous donne la possibilité de valider, de gérer, de sécuriser et de mettre à jour les configurations pour chaque opération séparément.
Si aucune définition OpenAPI n’est fournie, Gestion des API génère des opérations génériques pour les verbes HTTP courants (GET, PUT, etc.). Ajoutez un chemin d’accès ou des paramètres requis à une opération générique pour transmettre une demande d’API à l’API back-end.

Avec les opérations génériques, vous pouvez toujours tirer parti des mêmes fonctionnalités de Gestion des API, mais les opérations ne sont pas définies au même niveau de détail par défaut. Dans les deux cas, vous pouvez modifier ou ajouter des opérations à l’API importée.

Exemple

Votre application web principale peut prendre en charge deux opérations GET :

https://<app-service>.azurewebsites.net/customer/{id}
https://<app-service>.azurewebsites.net/customers

Vous importez l’application web dans votre service Gestion des API à un chemin comme https://<api>.azureapi.net/store. Le tableau suivant présente les opérations importées dans Gestion des API, avec ou sans spécification OpenAPI :

Type	Opérations importées	Exemples de demandes
Spécification OpenAPI	`GET /customer/{id}` `GET /customers`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.azureapi.net/store/customers`
Caractère générique	`GET /*`	`GET https://<api>.azureapi.net/store/customer/1` `GET https://<api>.azureapi.net/store/customers`

L’opération générique autorise les mêmes requêtes au service back-end que les opérations dans la spécification OpenAPI. Toutefois, les opérations spécifiées par OpenAPI peuvent être gérées séparément dans Gestion des API.

Prérequis

Terminez le démarrage rapide Créer une instance Azure API Management.
Vérifiez qu’il existe un service d’application dans votre abonnement. Pour plus d’informations, consultez Documentation d’App Service.

Pour plus d’informations sur la création d’un exemple d’API web et sa publication en tant qu’application web Azure, consultez :
- Tutoriel : Créer une API web avec ASP.NET Core.
- Publiez une application ASP.NET Core sur Azure avec Visual Studio Code.

Importer et publier une API back-end

Conseil

Dans les étapes suivantes, vous démarrez l’importation à l’aide de Gestion des API dans le portail Azure. Vous pouvez également créer un lien vers Gestion des API directement à partir de votre application web en sélectionnant Gestion des API dans le menu API de l’application.

Accédez au service Gestion des API dans le portail Azure.
Dans le menu de gauche, dans la section API, sélectionnez API, puis sélectionnez + Ajouter une API.
Sélectionnez la vignette App Service :
Sélectionnez Parcourir pour afficher la liste des services d’application dans votre abonnement.
Sélectionnez un service d’application, puis cliquez sur le bouton Sélectionner . Si une définition OpenAPI est associée à l’application web sélectionnée, Gestion des API l’extrait et l’importe.

Si aucune définition OpenAPI n’est trouvée, Gestion des API expose l’API en générant des opérations génériques pour les verbes HTTP courants.
Ajoutez un suffixe d’URL d’API. Le suffixe est un nom qui identifie l’API dans l’instance Gestion des API. Il doit être unique dans l’instance Gestion des API.
Si vous souhaitez que l’API soit publiée et disponible pour les développeurs, basculez vers l’affichage complet et associez l’API à un produit. Cet exemple utilise le produit Illimité . (Vous pouvez ajouter votre API à un produit lorsque vous le créez ou une version ultérieure via l’onglet Paramètres .)
Remarque

Les produits sont des associations d’une ou plusieurs API proposées aux développeurs via le portail des développeurs. Les développeurs doivent d’abord s’abonner à un produit pour obtenir l’accès à l’API. Une fois qu’ils s’abonnent, ils obtiennent une clé d’abonnement pour n’importe quelle API du produit. En tant que créateur de l’instance Gestion des API, vous êtes administrateur et êtes abonné à chaque produit par défaut.

Dans certains niveaux, chaque instance Gestion des API est fournie avec deux exemples de produits par défaut :
- Starter
- Illimité
Entrez d’autres paramètres d’API. Vous pouvez définir ces valeurs lorsque vous créez l’API ou les configurez ultérieurement en accédant à l’onglet Paramètres. Les paramètres sont expliqués dans le didacticiel Importer et publier votre première API .
Sélectionnez Create (Créer).

Tester la nouvelle API dans le Portail Azure

Vous pouvez appeler des opérations directement depuis le portail Azure. Cette méthode fournit un moyen pratique de visualiser et de tester les opérations d’une API. Vous pouvez également tester l’API dans le portail des développeurs ou à l’aide de vos propres outils clients REST.

Sélectionnez l’API que vous avez créée à l’étape précédente.
Sous l’onglet Test , sélectionnez une opération.

La page affiche des champs pour les paramètres de requête et des champs pour les en-têtes. L’un des en-têtes est Ocp-Apim-Subscription-Key. Cet en-tête concerne la clé d’abonnement du produit associé à l’API. Si vous avez créé l’instance Gestion des API, vous êtes déjà administrateur, de sorte que la clé est renseignée automatiquement.
Appuyez sur Envoyer.

Lorsque le test est réussi, le back-end répond avec 200 OK et des données.

Tester une opération générique dans le portail

Lorsque des opérations génériques sont générées, elles peuvent ne pas correspondre directement à l’API back-end. Par exemple, une opération GET générique importée dans Gestion des API utilise le chemin d’accès / par défaut. Toutefois, votre API back-end peut prendre en charge une opération GET sur le chemin d’accès /api/todoItems.

Pour tester le chemin d’accès /api/todoItems :

Sélectionnez l’API que vous avez créée, puis sélectionnez une opération.
Sous l’onglet Test , sous Paramètres de modèle, mettez à jour la valeur en regard du nom générique (*). Par exemple, entrez api/todoItems. Cette valeur est ajoutée au chemin d’accès / pour l’opération générique.
Sélectionnez Envoyer.

Ajouter d’autres API

Vous pouvez composer une API à partir d'API exposées par différents services, notamment :

Une spécification OpenAPI
Une API SOAP
Une API GraphQL
Une application web hébergée dans Azure App Service
Les fonctions Azure
Azure Logic Apps
Azure Service Fabric

Remarque

Lorsque vous importez une API, les opérations sont ajoutées à votre API actuelle.

Pour ajouter une API à une API existante :

Accédez à votre instance Azure API Management dans le portail Azure :
Sélectionnez API dans la page Vue d’ensemble, ou sélectionnez API>API dans le menu de gauche.
Sélectionnez les points de suspension (...) à côté de l’API à laquelle vous souhaitez ajouter une autre API.
Sélectionnez Importer dans le menu déroulant :
Sélectionnez un service à partir duquel importer une API.

Commentaires

Cette page a-t-elle été utile ?

Last updated on 2025-05-20