Utiliser Postman pour concevoir une API

Lorsque vous débutez dans le développement backend, particulièrement si vous travaillez sur une API, l’outil essentiel pour vous aider dans votre développement s’appelle Postman.

À quoi sert Postman

Disponible sur Linux, MacOS et PC, Postman sert à effectuer des requêtes HTTP que vous pourriez difficilement faire via votre navigateur ou via des requêtes curL. L’avantage est de pouvoir avoir une interface graphique pour manipuler votre API.

Faire des requêtes POST, PUT, PATCH et DELETE

Lorsque vous développez un serveur et ses différents comportements, vous allez avoir besoin de tester ses fonctionnalités assez tôt dans le développement. Pour ne pas avoir à dépendre du développement du frontend avant de pouvoir tester les comportements de votre serveur, Postman vous permet de faire les requêtes directement via son interface.

Là où un navigateur simple vous permet de faire des requêtes GET directement dans la barre d’URL, Postman permet d’avoir une interface graphique pour manipuler les différents query parameters, HTTP methods, request headers et request body afin de tester votre serveur avant même d’avoir développé le client.

Au fur et à mesure que votre API se complexifie, vous allez avoir des cas d’usage qui nécessitent plusieurs appels.

Grâce à Postman et l’utilisation de ses collections, vous pourrez lancer vos appels de manière séquentielle et utiliser la réponse des appels précédents dans les appels suivants, le tout sans avoir à copier/coller les données.

Effectuer des tests automatisés

Non seulement Postman permet d’effectuer des requêtes séquentielles, mais il permet également de les évaluer. Grâce à sa librairie de test et sa syntaxe JavaScript, vous pourrez évaluer le résultat d’une requête pour vous assurer de sa réponse. Par exemple dans une requête PUT, vous pourrez vérifier qu’à une étape donnée de la séquence, le statut de la réponse est bien 200 et que le body contient bien l’élément modifié.

Il est également compatible avec la librairie Newman qui permet de lancer cette suite de test directement en ligne de commande et de l’intégrer dans un pipeline d’intégration continu DevOps.

Débuter avec Postman

Installer Postman

Quel que soit votre système d’exploitation, rendez-vous sur le site de postman pour télécharger le fichier d’installation.

Si vous aviez déjà installé l’extension sur votre navigateur, prenez le temps de la supprimer. Ce client a été déprécié par l’équipe fondatrice pour se concentrer sur son client natif.

Exécuter ses premières requêtes

Une fois le client installé, assurez-vous d’avoir lancé votre serveur, en local ou un serveur en ligne puis saisissez l’endpoint que vous voulez tester dans l’URL.

Vous pourrez choisir la méthode HTTP, définir les headers et le body.

Aller plus loin avec Postman:

• Utiliser des variables dans ses requêtes
• Configurer une suite de tests