Comment déboguer des API avec Postman –
Postman est un programme et une boîte à outils qui facilitent le travail, le développement et le débogage des services API distants. Il fournit une plate-forme pour créer, gérer et travailler avec les requêtes GET et POST.
Qu’est-ce que Postman?
Postman se décrit comme une «plateforme de développement d’API». À son niveau le plus élémentaire, il fournit une interface graphique simple pour interagir avec des API distantes. Il s’agit essentiellement d’un client REST de pointe, conçu pour travailler avec des API complexes.
En plus d’être un excellent client REST, il propose également des outils de gestion des collections de requêtes. En utilisant ces collections et une connaissance du schéma d’API, il peut exécuter des tests d’API entièrement automatisés, qui peuvent être intégrés dans des pipelines CI / CD pour garantir que toute modification de code ne rompt pas l’API en production.
Utilisation du facteur
Pour commencer, nous allons tester une requête de base. Vous pouvez enregistrer plusieurs demandes dans des collections, qui peuvent être réutilisées et partagées.
Dans Postman, chaque demande a son propre onglet dans l’espace de travail. Vous trouverez des contrôles pour les paramètres de demande, ainsi que la sortie du serveur. Si vous l’utilisez en plein écran, vous pouvez le basculer en mode colonne côte à côte avec le bouton en bas à droite.
Vous pouvez modifier le type de demande dans la liste déroulante de la barre d’URL. Les méthodes les plus courantes sont GET et POST, mais tous les verbes HTTP sont entièrement pris en charge.
Sous l’onglet «Authentification», vous devrez configurer les clés d’authentification pour l’API que vous utilisez, sauf si elle est publique. Postman prend en charge OAuth 1 et 2, ainsi que la plupart des autres types de jetons en plus de l’authentification de base.
Sous «En-têtes», vous pouvez définir les en-têtes du message, tels que Content-Type. Beaucoup d’entre eux seront définis automatiquement, que vous pouvez afficher sous le bouton «Caché».
Pour le corps de la requête, vous pouvez spécifier des données de formulaire à l’aide de paires clé-valeur, envoyer un package binaire, une requête GraphQL ou simplement envoyer des données JSON ou texte brutes. L’éditeur comprend un éditeur et un validateur JSON intégrés.
L’une des choses les plus intéressantes que vous pouvez faire avec Postman est de configurer des tests d’API – ceux-ci sont codés en JavaScript et exécutés une fois le résultat reçu. Vous pouvez en savoir plus sur leur configuration à partir du guide du facteur pour les utiliser
Une fois que vous avez préparé votre demande, vous pouvez la tester avec le bouton «Envoyer». Vous devriez obtenir une réponse du serveur distant, que vous pouvez afficher dans Pretty-print, en aperçu HTML ou simplement en sortie brute. Vous pouvez voir diverses statistiques, comme le code de réponse HTML, la taille de la charge utile et le ping, dans la barre d’état au-dessus du
Vous pouvez également modifier la liste déroulante de « Corps » à « En-tête » pour afficher les en-têtes renvoyés par l’API.
À l’aide des testeurs JavaScript, vous pouvez également créer des visualisations de données simples, telles que des graphiques à secteurs et à barres, qui peuvent être utiles pour donner un sens à un grand nombre de données.
Si vous souhaitez y revenir ou enregistrer le test, vous pouvez l’enregistrer dans une « Collection ». Vous pouvez ensuite utiliser Collection Runner à partir de la barre de menus supérieure pour exécuter toutes les requêtes et tous les tests de la collection, qui peuvent être utilisés pour tester tous les points de terminaison d’API.