Postman

Présentation

En tant que développeur front-end, il est souvent nécessaire de faire appel à des APIs REST. Il est alors tentant, après une rapide lecture de la documentation de l’API (si elle existe), de se lancer directement dans l’implémentation du code permettant à votre application de dialoguer avec le serveur.

Toutefois, cela peut rapidement conduire à des bugs, parfois provoqués par notre implémentation, parfois dus à une mauvaise formalisation de nos requêtes. Les causes d’erreurs sont nombreuses. C’est d’autant plus vrai en entreprise, où les API sont rapidement amenées à évoluer, ne collant plus toujours à ce que décrit la documentation.

Pour gérer plus facilement ce processus, le mieux est de le diviser en étapes. Il existe de nombreuses applications, nommées plateformes API, qui permettent depuis une interface graphique de facilement émettre des requêtes HTTP en direction d’APIs. Ces applications nous permettent de configurer en profondeur le contenu de nos requêtes et fournissent un grand nombre d’informations sur le retour fait par l’API. Cela permet de facilement vérifier le fonctionnement d’une API avant d’écrire la moindre ligne de code.

Dans ce chapitre, nous allons présenter la plateforme API Postman. Libre à vous d’en utiliser une autre si vous le souhaitez.

Le fonctionnement de Postman

Installation

Postman est une application qu’il vous est possible d’utiliser comme Web Application directement via un navigateur web, ou comme une application Desktop en la téléchargeant. Il vous faudra créer un compte pour utiliser Postman en ligne.

Emettre une requête

Une fois l’application lancée et votre compte créé, vous pouvez ouvrir un nouvel onglet pour créer une requête en cliquant sur “Send a request” ou “Create New”.

Vous accédez à un nouvel onglet dans lequel est présent une barre où il est possible de renseigner une URL. Indiquez-y l’URL à laquelle vous souhaitez envoyer une requête HTTP. A gauche, spécifiez le type de requête que vous souhaitez émettre :

Si vous émettez une requête de type GET, vous pouvez spécifier des options directement dans l’URL comme vous le feriez dans un navigateur. Vous pouvez également utiliser l’onglet Params pour renseigner vos options une par une :

Dans le cas d’une requête POST ou PUT, vous pouvez indiquer les données que vous souhaitez transmettre dans le corps de votre requête dans la partie Body. Pensez à bien spécifier le format de données que vous voulez transmettre : si vous fournissez des données au format JSON par exemple, indiquez bien le type raw et le format JSON :

Une fois tout paramétré, vous pouvez appuyer sur Send pour envoyer votre requête.

Recevoir une réponse

A chaque fois que vous envoyez une requête, vous recevez dans la partie en bas de l’application les détails de la réponse. Vous retrouvez notamment en haut à droite le code de statut de la réponse. Au centre, vous avez un aperçu du corps de la réponse, que vous pouvez indenter selon différents formats : JSON, HTML, etc.

Ajouter un jeton d’authentification

Si vous avez besoin de fournir un jeton d’authentification (JWT) dans l’en-tête de votre requête, vous pouvez vous rendre dans la partie Authorization. Sélectionnez le type d’authentification (Bearer Token pour les JWT) et renseignez votre jeton dans le champ disponible :

TIP

Vous pouvez également utiliser des variables pour renseigner dans l’application des informations redondantes entre vos requêtes, comme les jetons. C’est particulièrement utile pour gérer les éléments d’authentification, ou encore les éléments dépendants d’un environnement de travail comme l’URL du serveur back-end, etc. Plus d’infos sur les variables dans la documentation de Postman sur les variables.

Créer des collections

Postman offre bien d’autres possibilités que de simplement échanger via des requêtes HTTP. Vous pouvez notamment créer des collections de requêtes et ainsi vous constituer une bibliothèque avec l’ensemble des requêtes dont vous avez besoin en tant que développeur front-end, ou toutes celles que vous fournissez en tant que développeur back-end.

Ils vous est ensuite possible d’exporter ces collections pour les échanger facilement avec d’autres développeurs travaillant avec vous, ou encore les mettre sur le repository de votre projet. Cela facilite grandement la communication autour de la façon d’échanger entre client et serveur.

INFO

💡 Pour aller encore plus loin, vous pouvez utiliser Postman pour effectuer des tests end-to-end de vos API.

Aller plus loin

• Sur Postman : la documentation