Comment déboguer les API avec Postman

0
178

Postman est un programme et une boîte à outils qui facilitent l'utilisation, le développement et le débogage des services d'API distants. Il fournit une plate-forme pour créer, gérer et travailler avec des 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 basique, 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 fonctionner avec des API complexes.

En plus d'être un excellent client REST, il propose également des outils pour gérer les collections de demandes. En utilisant ces collections et une connaissance du schéma de l'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 qu'aucune modification de code n'endommage l'API en production.

Utiliser Postman

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 l'échanger en mode colonne côte à côte avec le bouton en bas à droite.

Publicité

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'“Authentification” onglet, vous devrez configurer les clés d'authentification pour l'API que vous utilisez, à moins qu'elle ne soit publique. Postman prend en charge OAuth 1 et 2, ainsi que la plupart des autres types de jetons aux côtés 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 voir sous l'onglet “Caché” bouton.

Pour le corps de la demande, vous pouvez spécifier des données de formulaire à l'aide de paires clé-valeur, envoyer un package binaire, une demande 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 cool que vous peut faire avec Postman est mis en place des tests API—ceux-ci sont codés en JavaScript et exécutés après la réception du résultat. Vous pouvez en savoir plus sur leur configuration dans le guide d'utilisation de Postman

Une fois que vous avez préparé votre demande, vous pouvez la tester avec l'option “Envoyer” bouton. Vous devriez obtenir une réponse du serveur distant, que vous pouvez afficher dans Pretty-print, un aperçu HTML ou simplement une sortie brute. Vous pouvez voir diverses statistiques, telles que le code de réponse HTML, la taille de la charge utile et le ping, dans la barre d'état au-dessus de

< /p> Publicité

Vous pouvez également modifier la liste déroulante de “Body” à “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 à de nombreuses données.< /p>

Si vous souhaitez y revenir ou enregistrer le test, vous pouvez l'enregistrer dans une “Collection.” Vous pouvez ensuite utiliser Collection Runner dans la barre de menus supérieure pour exécuter toutes les demandes et tous les tests de la collection, qui peuvent être utilisés pour tester unitairement tous les points de terminaison de l'API.