Qu'est-ce que Postman?

Conseil informatique

Qu'est-ce que Postman?

15 avril, 2020 Blog 0

Qui n'a pas subi le monde des API dans ses os? Si vous êtes développeur Web, et surtout vous vous êtes concentré sur le développement de vos projets dans des architectures de microservices, Vous avez sûrement vu le besoin de gérer plusieurs API (qu'il s'agisse de votre propre système ou d'intégrations avec des applications tierces) qui doit être entretenu aussi rapidement et efficacement que possible.

Dans cet article, nous allons nous présenter au monde de Postman, un outil que si vous ne le saviez pas, rendra le travail avec les API passionnant.

Qu'est-ce que Postman?

Postman est apparu à l'origine comme une extension pour le navigateur Google Chrome. Aujourd'hui, il a des applications natives pour MAC et Windows et ils travaillent sur une application native pour Linux (disponible en version bêta).

Il est composé de différents outils et utilitaires gratuits (dans la version gratuite) qui permettent d'effectuer différentes tâches dans le monde de l'API REST:

  1. Création de requêtes vers des API internes ou tierces.
  2. Développement de tests pour valider le comportement des API.
  3. Possibilité de créer différents environnements de travail (avec des variables globales et locales).

Tout cela avec la possibilité d'être partagé avec d'autres coéquipiers gratuitement (export de toutes ces informations via URL au format JSON).

En outre, dispose d'un mode cloud collaboratif (de paiement) afin que les équipes de travail puissent développer conjointement des collections d'API synchronisées dans le cloud pour une intégration plus immédiate et synchronisée.

Entrons dans le sujet: Collections d'API

L'intérêt fondamental de Postman est que nous l'utilisons comme outil pour faire des requêtes aux API et produire collections de pétitions qui nous permettent de les tester rapidement et facilement.

Les collections sont des dossiers où sont stockées les requêtes et qui permettent de les structurer par ressources, modules ou selon les souhaits de l'équipe. Dans l'image suivante, nous voyons un exemple de la structure d'une collection de test de l'un des projets développés dans Paradigma: Centre de sécurité.

Comme on le voit, vous pouvez définir le type de demande (AVOIR, PUBLIER, etc.), jetons d'authentification, en-têtes associés à la requête, etc., le tout d'une manière très simple.

Tous les appels stockés dans notre collection peuvent être exportés vers plusieurs langues en cliquant sur la section Générer du code que vous pouvez voir dans la capture d'écran précédente.. Je vous laisse un exemple de la façon dont un appel GET exporte pour être utilisé automatiquement à partir du code Python:

Tous les appels stockés dans notre collection peuvent être exportés vers plusieurs langues en cliquant sur la section Générer du code que vous pouvez voir dans la capture d'écran précédente..


import requests
url = "http://localhost:8000/api/customers/"
headers = {
    'content-type': "application/json",
    'cache-control': "no-cache",
    'postman-token': "1432412f-9bc5-be13-a8a4-6f93e31feba4"
    }
response = requests.request("POST", url, headers=headers)
print(response.text)

Il est fragment le code permet d'exécuter la requête depuis une application Python tout comme Postman l'exécute depuis son interface, peindre la réponse du serveur par la console.

Environnements de travail

L'un des points les plus puissants de Postman, à mon avis, est la possibilité de définir toutes les variables ce dont vous avez besoin et classez-les par les environnements de travail.

Ceci est très utile lorsque vous avez différents projets ou lorsque vous devez configurer plusieurs environnements pour le même projet. (par exemple, différents en-têtes, URL de chacun des environnements de travail – local, pré-production ou même production, etc.).

Pour configurer les environnements et leurs variables, vous verrez que dans le coin supérieur droit de l'interface il y a un menu déroulant dans lequel vous pouvez lire "Pas d'environnements". Si vous cliquez sur le bouton Paramètres à côté, une option apparaît appelée "Gérer les environnements« Où vous pouvez configurer chacun d'eux:

Une fois configuré, son utilisation dans n'importe quel appel et dans n'importe quelle collecte est très simple. Si par exemple on définit l'url de la ressource avec le nom URL_hôte comme variable d'environnement (ou mondial), vous pouvez utiliser cette variable en écrivant la clé entre doubles accolades. Par exemple:

De cette manière, il est très simple de changer l'url de tous les appels définis dans la collection (vous n'avez qu'à sélectionner l'environnement correspondant).

Développez des tests API en quelques minutes et automatisez-les dans votre Jenkins

Une autre caractéristique intéressante, surtout pour les QA d'équipe, il est la possibilité d'automatiser les tests d'intégration de manière simple pour nos projets. Dans chacun des appels, Postman nous fournit un onglet de tests dans lequel configurer les tests que vous souhaitez.

Postman s'appuie sur du code Javascript pour programmer ses tests. Je ne sais pas programmer en JS? Ne t'inquiète pas, Postman a pris soin de proposer un ensemble d'extraits de test qui vous permettent de faire du développement de vos tests un jeu d'enfant.

Dans le lien suivant vous pouvez voir plus de documentation sur les tests.

L'un des aspects les plus demandés, et que Postman a développé il n'y a pas longtemps, est la possibilité d'automatiser les tests afin que notre logiciel IC exécute les tests dans le flux de construction de nouvelles versions.

Toute personne intéressée, vous pouvez visiter le blog de facteur, où il est expliqué étape par étape comment les intégrer dans Jenkins.

Documentez votre API

Dans chaque collection que vous générez dans votre API, Postman donne la possibilité de générer une documentation Web en accès libre où il peint tous les appels avec les en-têtes définis et, juste à coté, un exemple d'appel à tester immédiatement avec cURL:

Pour consulter la documentation, cliquez dans la collection sur le symbole ">» Et dans le menu qui apparaît à droite, Cliquer sur Afficher les documents:

Conclusion

Sans doute, Postman est un outil qui devient indispensable dès la première utilisation.

Comment cela aide-t-il au développement, permet à l'équipe de conserver une collection à jour de tous vos appels de service ou une collection qui vous permet de tester rapidement l'intégration avec des API tierces.

Au jour d'aujourd'hui, il existe des applications Postman natives pour Windows, OSX et Linux (bêta), afin que tout développeur puisse bénéficier de ses avantages.

En outre, la possibilité d'exporter toute la collection dans un fichier .json permet à l'équipe de versionner la collection dans le système de contrôle de version, et qu'il s'agit d'un document collaboratif qui aide tous les membres de l'équipe à mettre à jour leur collection de manière immédiate.