Nouvelles Chroniques d'Amethyste

Penser au Sens, pas au Verbe

Tutoriel Postman

Poster un commentaire

Postman est un client REST proposé par Google. Il est disponible sous la forme d’une extension Chrome ou bien d’une application stand-alone.

Je m’en sers depuis des années et je trouve que c’est un des meilleurs que j’ai pu tester. C’est pourquoi je souhaiterai vous le faire découvrir.

L’outil permet de créer des règles sous la forme d’url vers le service REST avec lesquelles ont définit des paramètres d’entête, de chaîne de requête, d’authentification. On choisit également un verbe HTTP comme GET.

Ces règles peuvent être enregistrées dans des collections et des sous collections.

L’écran principal ressemble à celui-ci:

2016-02-23_23-15-40

  1. Onglet qui permet de basculer entre la collection de requêtes et l’historique des tests
  2. Boutons avec différentes commandes, en particulier l’import/export de règles
  3. Liste des règles que l’on peut regrouper en catégories (comme ici). On aperçoit 4 catégories dans notre exemple
  4. Zone de définition d’une règle
  5. Création de variables d’environnement
  6. Réinitialisation de la zone de création d’une règle

 

Les opérations de base

Faisons notre premier essai :

2016-02-23_23-30-10

 

  1. On saisit une url, par exemple http://www.google.fr
  2. On clique sur SEND
  3. Il s’affiche le résultat de la requête

2016-02-23_23-32-31

 

  1. On peut sélectionner plusieurs modes d’affichage. Sélectionnons PREVIEW, cela affiche le rendu HTML de la page Google que nous connaissons bien
  2. Diverses informations sont disponibles comme le statut HTTP, la durée de la requête.
    Mais on peut également visualiser les cookies et les entêtes renvoyés par la requête en cliquant sur les onglets
  3. Le panneau Collection contient l’historique de nos requêtes

 

2016-02-23_23-36-16

Cliquons sur le bouton Add to Collection:

2016-02-23_23-39-16

On a la possibilité d’ajouter la requête à une collection existante ou bien dans une nouvelle collection.

Si on souhaite alimenter une collection existante on la sélectionne dans la liste déroulante (1). Autrement on saisit le nom d’une nouvelle collection en (2). Appelons là Google.

En (3) on donne un nom convivial à la requête et un éventuel descriptif en (4) avant de cliquer sur (5) pour enregistrer tout.

2016-02-23_23-43-18

Remarquez les icônes qui s’affichent lorsque l’on survole une collection ou une règle:

2016-02-23_23-44-17

Ils servent respectivement à Renommer, Partager la collection ou la supprimer.

2016-02-23_23-47-00

Le partage peut se faire sous la forme d’un partage cloud ou bien d’un fichier JSON.

Création d’une règle

Examinons plus en détail le formulaire de création. Son apparence varie selon le verbe HTTP:

2016-02-24_18-34-00

La saisie d’une requête complexe alimente automatiquement l’onglet URL Params qui analyse la chaîne de requête.

2016-02-24_18-43-26

On peut bien entendu les saisir à la main.

Cliquons sur le bouton Headers ainsi que URL Params pour n’afficher que les entêtes.

2016-02-24_18-57-08

On retrouve un formulaire similaire que l’on peut également compléter à la main.

Tous ces paramètres seront sauvegardés en même temps que la règle dans la collection.

 

Concernant les entêtes on a la possibilité de définir des collections de valeurs en sélectionnant Manage Presets:

2016-02-24_18-59-32

On clique sur Add:

2016-02-24_19-00-27

On donne un nom à la collection d’entêtes puis on saisit une liste de clef/valeur et on sauvegarde avec Submit.

Pour la suite il suffit d’entrer les premières lettres du nom de la collection, on sélectionne la collection d’entêtes dans la liste qui s’affiche et les valeurs sont chargées.

 

Il est également possible de paramétrer le contenu de la requête elle-même. par exemple cette recherche Bing:

https://www.bing.com/search?q=postman

On pourrait par exemple réutiliser cette requête pour différentes valeurs possibles du paramètre q.

Dans un autre scénario on pourrait avoir des environnements de dev, recette, prod et souhaiter créer un Template de règle dans lequel on ne change que l’url.

On voudrait éviter de le faire à la main ce qui est laborieux.

 

on peut définir des environnements qui peuvent s’appeler dev, recette, prod par exemple. Dans notre exemple il s’appèlerons juste:

  • postman
  • Newman

On clique sur No Environment tout en haut de l’écran, puis Manage Environments:

2016-02-24_19-20-10

On clique sur Add:

2016-02-24_19-21-22

Nous avons définit un environnement postman avec une variable appelée query dont la valeur sera ‘postman’. On Clique sur Submit et on fait de même avec ‘Newman’.

On modifie ensuite la requête:

https://www.bing.com/search?q=query

 

Dans laquelle on reconnaît notre paramètre.

2016-02-24_19-24-01

Sélectionnez un environnement puis faites SEND.

La requête avec les bons paramètres est lancée.

Pour finir

Postman est un de ces outils qu’il faut connaître. Je voudrai aussi signaler Newman un outil qui tourne sous Mode très complémentaire. Avec Newman vous allez pouvoir scripter les règles créées dans Postman afin d’automatiser les tests de vos Web Api.

 

https://www.getpostman.com/docs/newman_intro

http://blog.getpostman.com/2015/09/03/how-to-write-powerful-automated-api-tests-with-postman-newman-and-jenkins/

 

Ce n’est pas tout, j’ai également rédigé un petit tuto pour monter comment utiliser OAuth 1 avec Postman:

https://amethyste16.wordpress.com/2016/12/14/utiliser-oauth-1-avec-postman/

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Publicités

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s