Importer une application conteneur Azure en tant qu’API

2025-04-16

S’APPLIQUE À : tous les niveaux de Gestion des API

Cet article explique comment importer une application conteneur Azure dans Gestion des API Azure en tant qu’API et tester l’API importée à l’aide du portail Azure.

Remarque

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

Dans cet article, vous apprendrez comment :

Importer une application conteneur qui expose une API web
Tester l’API dans le portail Azure

Exposer une application conteneur à l’aide de Gestion des API

Azure Container Apps vous permet de déployer des applications conteneurisées sans avoir à gérer une infrastructure complexe. Les développeurs d’API peuvent écrire du code avec leur langage de programmation ou infrastructure préféré, créer des microservices avec prise en charge complète du runtime d’application distribué (Dapr) et mettre à l’échelle en fonction du trafic HTTP ou d’autres événements.

En utilisant Gestion des API pour exposer une API web hébergée dans une application conteneur, vous bénéficiez des avantages suivants :

Dissociez la gestion et la sécurisation du front-end exposé aux consommateurs d’API de la gestion et de la surveillance de l’API web principale.
Gérez les API web hébergées en tant qu’applications conteneur 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.

Spécification OpenAPI et opérations génériques

Gestion des API prend en charge l’importation d’applications conteneur qui fournissent une spécification OpenAPI (définition Swagger). Une spécification OpenAPI n’est pas obligatoire, mais nous vous recommandons de en fournir une. Gestion des API peut importer des opérations individuelles, ce qui vous permet de valider, gérer, sécuriser et mettre à jour des configurations pour chaque opération séparément.

Si l’application conteneur expose une spécification OpenAPI, Gestion des API crée des opérations d’API qui correspondent directement à la définition. Gestion des API recherche plusieurs emplacements pour obtenir une spécification OpenAPI :

Configuration de l’application conteneur
/openapi.json
/openapi.yml
/swagger/v1/swagger.json

Si aucune spécification OpenAPI n’est fournie, Gestion des API génère des opérations génériques pour les verbes HTTP courants (GET, PUT, etc.). 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.

Dans les deux cas, vous pouvez modifier ou ajouter des opérations à l’API après l’avoir importée.

Exemple

Votre application conteneur back-end 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 conteneur dans votre service Gestion des API à un chemin comme https://<api>.azure-api.net/store. Le tableau suivant répertorie les opérations qui sont importées dans Gestion des API, avec ou sans spécification OpenAPI :

Catégorie	Opérations importées	Exemples de demandes
Spécification OpenAPI	`GET /customer/{id}` `GET /customers`	`GET https://<api>.azure-api.net/store/customer/1` `GET https://<api>.azure-api.net/store/customers`
Caractère générique	`GET /*`	`GET https://contosoapi.azure-api.net/store/customer/1` `GET https://<api>.azure-api.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

Suivez le guide de démarrage rapide Créer une instance du service Gestion des API Azure.
Vérifiez qu’il existe une application conteneur qui expose une API web dans votre abonnement. Pour plus d’informations, consultez la documentation de Container Apps.

Importer et publier une API back-end

Accédez à votre service de gestion des API dans le portail Azure et sélectionnez API>API dans le volet gauche.
Sous Créer à partir d’une ressource Azure, sélectionnez Application conteneur :
Sélectionnez Parcourir pour afficher la liste des applications conteneur dans votre abonnement.
Sélectionnez une application conteneur. Si une définition OpenAPI est associée à l’application conteneur 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.
Associez l’API à un produit. Sélectionnez Complet , puis, dans Product, sélectionnez le produit. Dans ce cas, le produit Illimité est utilisé. Si vous souhaitez que l’API soit publiée et disponible pour les développeurs, vous devez l’ajouter à un produit.
Remarque

Les produits sont des associations d’une ou plusieurs API. Vous pouvez inclure de nombreuses API et les proposer aux développeurs dans le portail des développeurs. Les développeurs doivent s’abonner à un produit pour obtenir l’accès à l’API. Lorsqu’ils s’abonnent, ils obtiennent une clé d’abonnement adaptée à n’importe quelle API de ce produit. Si vous avez créé l’instance Gestion des API, vous êtes un administrateur et vous êtes abonné à tous les produits par défaut.

Dans certains niveaux tarifaires, une instance Gestion des API est fournie avec deux exemples de produits lorsque vous le créez :
- Démarreur
- 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 sous l’onglet Paramètres. Ces 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 Microsoft Azure. Cette méthode est un moyen pratique d’afficher 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.

Pour tester l’API dans le portail Azure :

Sélectionnez l’API que vous avez créée à l’étape précédente.
Sélectionnez 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 administrateur, de sorte que la clé est renseignée automatiquement.
Sélectionnez 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 à l’emplacement suivant :

/api/TodoItems

Pour tester le chemin /api/TodoItems :

Sélectionnez l’API que vous avez créée, puis sélectionnez l’opération.
Sélectionnez l’onglet Test.
Dans Paramètres du modèle, mettez à jour la valeur à côté 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.

Partager via