Comment utiliser une API avec Postman ?

Aujourd’hui, tous les services web sont accessibles grâce aux APIs. Il s’agit de fournisseurs de données qu’il est possible d’utiliser avec Postman. Celui-ci est l’instrument le plus incontournable dans le monde du développement web. Postman est un outil de référence que vous pouvez utiliser pour le développement PHP, Node.js, Ruby on Rails ou encore Python. Il suffit d’interagir avec une API, et le tour est joué. Comment utiliser une API avec Postman ? Découvrez ici quelques éléments de réponse.

Les requêtes HTTP

Postman est un outil permettant de faire des requêtes HTTP sur une interface graphique. Cette dernière facilite grandement l’exercice. Vous avez tout simplement à renseigner l’URL et la méthode HTTP. Il existe plusieurs méthodes HTTP qui diffèrent selon certains facteurs. Il s’agit de l’opération à faire et de l’API utilisée pour cela.

Parmi les méthodes les plus utilisées, figurent :

• GET
• POST
• PUT
• PATCH
• DELETE

Les requêtes GET sont celles qu’effectue un navigateur quand une URL est insérée dans la barre de navigation. Leur but est de chercher une donnée ou une page. En ce qui concerne les requêtes POST, elles ont pour but d’envoyer l’information qui se trouve dans le body de la requête. Elle est transmise vers le serveur. 

Les requêtes PUT sont utilisées pour écraser une ressource avec une nouvelle donnée. Elles permettent la mise à jour de la donnée. Quant aux requêtes PATCH, elles sont utiles pour mettre à jour une ressource tout en modifiant uniquement l’élément envoyé en body de la requête.

Enfin, la requête DELETE permet d’effacer une ressource. Les utilisations des requêtes varient compte tenu du serveur et de la manière dont il a été développé. Il s’agit de méthodes très communes pour les API REST. 

Les requêtes HTTP ont parfois des query params. Pour ceux qui le savent, il s’agit de données envoyées au serveur par l’URL, généralement dans les requêtes GET. Il est facile de définir et de modifier ces query params directement dans l’interface de Postman. Grâce à l’outil, vous pouvez modifier rapidement les query params ou les affecter à des variables.

Il est possible que les requêtes HTTP comportent des Request headers. Tout comme avec les query params, Postman permet de modifier facilement les headers via son interface graphique. 

L’intérêt de certaines requêtes résident dans le fait qu’elles envoient de la donnée au serveur grâce au Request body de la requête. Il s’agit de POST, PUT et de PATCH. Les données du body qu’il faut transmettre au serveur par le biais de Postman peuvent avoir des formats différents. Parmi les plus utilisés figure le format JSON. Pour les API SOAP, il y a le XML. 

Avec Postman, vous pouvez copier et coller un body dans une boîte de texte. Vous pouvez également choisir le format qu’il faut. Pour une requête POST, PUT ou PATCH, l’outil permet d’éditer le body de la requête. 

Il y a des appels HTTP qui requièrent une authentification de l’appelant. Il est possible de paramétrer les autorisations nécessaires à vos appels. Pour cela, il faut accéder à l’onglet Authorization de Postman. Sur l’outil, vous trouverez diverses formes d’authentification à l’image de la simple API key, le Basic Auth ou l’OAuth. 

Les collections

Au fur et à mesure de votre développement, votre API croît. De plus, les URLs à tester par Postman augmentent. Afin de vous aider à organiser et conserver les requêtes, l’outil met à votre disposition des collections. Ainsi, vous avez la possibilité d’enregistrer et classer une série de requêtes HTTP.

La façon dont les appels doivent être ordonnés dans votre collection dépend complètement de vous. En outre, Postman vous offre la possibilité d’exécuter automatiquement tous les appels d’une collection suivant un ordre. Il est donc très important de définir l’ordre. 

Utiliser les variables

Durant votre développement, vous aurez des appels qui dépendent de variables provenant d’autres requêtes. Par exemple, il est possible que vous ayez besoin de récupérer un id ou un token qui provient d’un premier appel dans le but de vérifier le second. 

Afin d’éviter de copier et coller toutes les fois que vous souhaitez lancer vos appels, vous pouvez vous servir des variables Postman. Celles-ci permettent de stocker une donnée reçue d’une requête afin de pouvoir la réutiliser dans d’autres appels à venir. 

Par ailleurs, les variables Postman sont disposées dans des scopes. Il en existe plusieurs dont les principaux sont: 

• variable Globale
• variable d’Environnement
• variable de collection
• variable Locale
• donnée.

Les scopes de variables peuvent être utilisés dans différentes collections. Ils peuvent aussi être utilisés pour créer des environnements dont les variables sont spécifiques. 

Afin de définir une variable, Postman met à votre disposition l’objet pm qui contient les fonctions SET et GET. En fonction du scope de la variable à définir, il est possible d’utiliser diverses formules. 

Rédiger des tests automatisés

Dans tout développement d’une API, il ne faut pas négliger les tests unitaires et fonctionnels. Ils permettent d’assurer le bon fonctionnement de l’API. Postman met également à votre disposition une fonction des tests. Ils permettent de “mocker” tout appel à une API extérieur. 

Pour le développement de votre Backend, les tests doivent couvrir une certaine logique. Par exemple, si vous faites appel à l’API de Twitter, vous n’aurez pas à faire réellement des appels à ce service toutes les fois que vous ferez des tests d’intégration. Il faudra “mocker” ces appels.

Vous pouvez avoir une suite de tests dans Postman qui pourront faire appel à tous les services externes. 

Construire une API dans Postman

En dehors de la possibilité de manipuler et tester une API, Postman vous permet aussi d’en construire une. Pour cela, il faut utiliser son API Builder. L’onglet API disponible sur l’outil constitue le point central de votre API. Celui-ci regroupe les tests, les collections, et bien plus encore. 

Grâce à cet onglet, vous pouvez centraliser toutes les ressources relatives à votre API à savoir la documentation. Lorsque le schéma de chaque ressource est défini, Postman est en mesure de générer les collections de façon automatique. En outre, Postman propose un Mock Server pour vous permettre de tester un consommateur d’une API.