Partager via

Importer une spécification OpenAPI

  • Article

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

Cet article comment importer une API back-end ayant une « spécification OpenAPI » dans Gestion des API Azure en utilisant différents outils. Il explique également comment tester l’API dans Gestion des API.

Dans cet article, vous apprendrez comment :

  • Importez une spécification OpenAPI à l’aide du Portail Azure, d’Azure CLI ou de Azure PowerShell.
  • Tester l’API dans le portail Azure

Notes

Les limitations d’importation d’API sont documentées dans les restrictions d’importation d’API et les problèmes connus.

Prérequis

Importer une API back-end

Pour cet exemple, vous importez la spécification OpenAPI pour l’API Petstore open source, mais vous pouvez la remplacer par une spécification OpenAPI de votre choix.

  1. Dans le portail Azure, accédez à votre instance APIM.

  2. Dans le menu de gauche, cliquez sur API > + Ajouter une API.

  3. Sous Créer à partir d’une définition, sélectionnez OpenAPI.

    Capture d’écran de la création d’une API à partir d’une spécification OpenAPI dans le portail

  4. Entrez les paramètres de l’API. Vous pouvez définir les valeurs lors de la création, ou les configurer ultérieurement en accédant à l’onglet Paramètres. Les paramètres sont expliqués dans le tutoriel Importer et publier votre première API.

  5. Sélectionnez Create (Créer).

Visualiser et modifier une spécification OpenAPI

Dans le portail, utilisez l’éditeur de spécification OpenAPI pour visualiser, valider ou modifier la spécification pour l’API que vous avez importée.

Pour utiliser l’éditeur de spécification OpenAPI :

  1. Dans le portail Azure, accédez à votre instance APIM.
  2. Dans le menu de gauche, sous API, sélectionnez API><votre API>>Toutes les opérations.
  3. Sous l’onglet Conception, dans Front-end, sélectionnez Éditeur de spécification OpenAPI (l’icône de crayon). Vous pouvez ouvrir la spécification au format JSON ou YAML.
  4. Passez en revue ou modifiez la spécification si nécessaire. Enregistrez les changements apportés.

Valider relativement à un schéma de spécification OpenAPI

Vous pouvez configurer la stratégies de validation Gestion des API pour valider les requêtes et réponses (ou leurs éléments) par rapport au schéma dans une spécification OpenAPI. Par exemple, utilisez la stratégie validate-content pour valider la taille ou le contenu d’une requête//du corps d’une réponse.

Tester la nouvelle API dans le portail

Les opérations peuvent être appelées directement à partir du portail, ce qui permet d’afficher et de tester facilement les opérations d’une API.

  1. Sélectionnez l’API que vous avez créée à l’étape précédente.

  2. Sélectionnez l’onglet Test.

  3. 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.

    Notes

    Dans la console de test, Gestion des API renseigne automatiquement un en-tête Ocp-Apim-Subscription-Key, et configure la clé d’abonnement de l’abonnement avec accès complet intégré. Cette clé permet d’accéder à toutes les API dans l’instance Gestion des API. Vous pouvez éventuellement afficher l’en-tête Ocp-Apim-Subscription-Key en sélectionnant l’icône « œil » en regard de la requête HTTP.

  4. En fonction de l’opération, entrez des valeurs de paramètre de requête, des valeurs d’en-tête ou un corps de requête. Sélectionnez Envoyer.

    Lorsque le test réussit, le backend répond avec un code de réponse HTTP réussi et quelques données.

    Conseil

    Par défaut, la console de test envoie une demande au proxy CORS de Gestion des API, qui transmet la demande à l'instance d'API Management, qui la transmet ensuite au backend. Ce proxy utilise l'adresse IP publique 13.91.254.72 et ne peut atteindre que les terminaux publics. Si vous souhaitez envoyer une requête directement du navigateur au service Gestion des API, sélectionnez Bypass CORS proxy. Utilisez cette option lorsque vous souhaitez utiliser la console de test et que votre passerelle de Gestion des API est isolée du réseau ou n'autorise pas le trafic provenant du proxy CORS.

Pour déboguer une API, consultez Tutoriel : Déboguer vos API à l’aide du suivi des requêtes.

Ajouter d’autres API

Vous pouvez composer une API à partir de plusieurs 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
  • Application Azure Function
  • Azure Logic Apps
  • Azure Service Fabric

Pour ajouter une autre API à votre API existante, effectuez les étapes suivantes.

Notes

Une fois que vous avez importé une autre API, les opérations sont ajoutées à votre API actuelle.

  1. Accédez à votre instance Gestion des API Azure dans le portail Azure.

    Capture d’écran de la navigation vers l’instance Gestion des API dans le portail.

  2. Sélectionnez API dans la page Vue d’ensemble ou dans le menu situé à gauche.

    Capture d’écran de la sélection d’API dans la page Vue d’ensemble du portail.

  3. Cliquez sur ... à côté de l’API à laquelle vous souhaitez ajouter une autre API.

  4. Sélectionnez Importer dans le menu déroulant.

    Sélectionner Importer

  5. Sélectionnez un service à partir duquel importer une API.

    Capture d’écran de la sélection d’un service dans le portail.

Étapes suivantes