Qu’est-ce que Postman ?

Postman est une plateforme de développement et de test d’API. Son client permet de préparer une requête, de l’envoyer à un serveur et d’examiner la réponse sans avoir à développer une interface utilisateur.

Vous pouvez ainsi tester une API existante ou vérifier les routes de votre propre application pendant son développement.

À quoi sert Postman ?

Quelques notions avant de commencer

Tutoriel : envoyer une première requête GET

1. Installer et ouvrir Postman

Téléchargez l’application de bureau depuis le site officiel de Postman , puis ouvrez une nouvelle requête HTTP.

2. Préparer la requête

Sélectionnez la méthode GET et saisissez l’adresse suivante :

https://postman-echo.com/get

Dans l’onglet Params, ajoutez les paramètres suivants en vérifiant qu’ils sont activés :

Postman construit alors une URL équivalente à :

https://postman-echo.com/get?produit=clavier&quantite=2

3. Envoyer et lire la réponse

Cliquez sur Send. Vérifiez le code de statut et examinez le corps JSON de la réponse. Il doit notamment contenir les paramètres reçus :

{   "args": {     "produit": "clavier",     "quantite": "2"   } }

Cet extrait est simplifié. La réponse complète contient également d’autres informations sur votre requête. Les paramètres présentés ici sont renvoyés sous forme de chaînes.

Envoyer des données JSON avec POST

Une requête POST permet de transmettre des données dans le corps de la requête. Leur traitement dépend de l’API appelée.

1. Créez une nouvelle requête et sélectionnez POST.
2. Saisissez l’URL https://postman-echo.com/post.
3. Dans Body, choisissez raw, puis le format JSON.
4. Saisissez le contenu ci-dessous, puis cliquez sur Send.

{   "nom": "Clavier mécanique",   "prix": 59.90,   "quantite": 2 }

Vérifiez que l’en-tête Content-Type est bien défini sur application/json. Postman l’ajoute normalement lorsque le format JSON est sélectionné.

Dans la réponse, la propriété json doit contenir les données envoyées :

{   "json": {     "nom": "Clavier mécanique",     "prix": 59.90,     "quantite": 2   } }

Ajouter des tests automatiques

Sur votre requête POST, ouvrez Scripts > Post-response. Ajoutez les tests suivants :

pm.test("Le statut HTTP est 200", function () {     pm.response.to.have.status(200); });  pm.test("Le produit reçu correspond au produit envoyé", function () {     const reponse = pm.response.json();      pm.expect(reponse.json.nom).to.eql("Clavier mécanique"); });  pm.test("La quantité reçue est un nombre égal à 2", function () {     const reponse = pm.response.json();      pm.expect(reponse.json.quantite).to.be.a("number");     pm.expect(reponse.json.quantite).to.eql(2); });

Cliquez de nouveau sur Send, puis consultez Test Results. Les trois tests doivent réussir si vous avez envoyé le JSON précédent.

Enregistrer les requêtes dans une collection

Une collection permet de conserver des requêtes et leurs tests pour les réutiliser.

1. Créez une collection nommée Découverte de Postman.
2. Enregistrez la requête GET sous le nom Lire des paramètres.
3. Enregistrez la requête POST sous le nom Envoyer un produit.

Vous disposez maintenant d’un petit ensemble de requêtes pour retrouver vos exemples et vérifier leur fonctionnement.

Les bonnes pratiques

• Donnez un nom explicite à chaque requête et indiquez son objectif dans sa description.
• Vérifiez les données renvoyées en plus du code HTTP : un statut de succès ne garantit pas leur exactitude.
• Utilisez des données fictives pour découvrir une API publique comme Postman Echo.
• Avant de partager une collection, retirez les clés API, jetons et données confidentielles.
• Vérifiez l’environnement ciblé avant d’exécuter une requête qui modifie ou supprime des données.