Exporter une définition d’API vers Postman pour le test, la surveillance et le développement d’API

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

Pour améliorer le développement de vos API, vous pouvez exporter une API gérée par Gestion des API vers Postman. Exportez une définition d’API à partir de Gestion des API en tant que collection Postman, afin de pouvoir utiliser les outils de Postman pour concevoir, documenter, tester et surveiller des API, ainsi que collaborer sur celles-ci.

Remarque

Seule la définition d’API peut être exportée directement de Gestion des API vers Postman. Les autres informations telles que les stratégies ou les clés d’abonnement ne sont pas exportées.

Prérequis

  • Suivez ce guide de démarrage rapide : Créer une instance du service Gestion des API Azure.

  • Assurez-vous que votre instance gère une API que vous souhaitez exporter vers Postman.

    Remarque

    Actuellement, vous pouvez uniquement exporter des API HTTP de Gestion des API directement vers Postman.

  • Un compte Postman que vous pouvez utiliser pour accéder à Postman for Web.

Accéder à votre instance Gestion des API

  1. Dans le portail Azure, recherchez et sélectionnez les services Gestion des API :

    Capture d’écran qui montre les services de gestion des API dans les résultats de recherche.

  2. Sur la page des services de gestion des API, sélectionnez votre instance de gestion des API :

    Capture d’écran qui montre une instance de gestion des API sur la page des services de gestion des API.

Exporter une API vers Postman

  1. Dans le portail, sous API, sélectionnez une API.

  2. Dans le menu contextuel (...), sélectionnez Exporter>Postman.

  3. Dans la boîte de dialogue Exécuter dans, sélectionnez l’emplacement Postman vers lequel exporter. Vous pouvez sélectionner l’option de l’application de bureau si vous l’avez installée localement.

  4. Dans Postman, sélectionnez un espace de travail Postman dans lequel importer l’API. L’espace de travail par défaut est Mon espace de travail.

  5. Dans Postman, sélectionnez Générer une collection à partir de cette API pour générer automatiquement une collection à partir de la définition d’API. Configurez des options d’importation avancées si nécessaire, ou acceptez les valeurs par défaut. Sélectionnez Importer.

    La collection et la documentation sont importées dans Postman.

    Capture d’écran de la collection importée dans Postman.

Développement d’API avec Gestion des API et Postman

Les développeurs d’API peuvent rapidement itérer sur les modifications d’API à l’aide des fonctionnalités de test, de surveillance et de développement d’API de Postman.

Les API développées dans Postman peuvent ensuite être exportées et réimportées dans Gestion des API en tant que révisions d’API. Cela vous permet de développer des API dans Postman, puis de les déployer sur Gestion des API pour l’accès au runtime et la gestion. Pour plus d’informations, consultez Déployer vers Azure API Management à partir du Postman API Builder.

Attention

Faites preuve de prudence lors de la transmission de clés d’abonnement Gestion des API ou d’autres données sensibles dans Postman. Postman Vault est recommandé pour stocker des données sensibles en tant que secrets de coffre dans votre instance de Postman, ce qui vous permet de réutiliser en toute sécurité les secrets dans vos collections et requêtes.

Contenu connexe

  • Last updated on