Tester API REST à l'aide de Postman

Tester API REST à l'aide de Postman
Postman est un logiciel que vous pouvez utiliser pour tester les API REST. Postman a une interface utilisateur graphique facile à utiliser. Il a également de nombreuses fonctionnalités utiles pour vous aider à tester votre API REST. Postman est disponible pour Windows, Mac et Linux. Postman est également disponible en tant que plugin chrome. Ainsi, vous pouvez utiliser Postman dans votre navigateur Google Chrome. Postman a une version gratuite et des versions payantes. Vous pouvez faire presque tout avec la version gratuite. J'utiliserai la version gratuite dans cet article.

Dans cet article, je vais vous montrer comment tester l'API REST en utilisant Postman. Commençons.

Installation de facteur comme extension chromée:

Dans cette section, je vais vous montrer comment installer Postman à partir de la boutique en ligne Chrome.

Tout d'abord, accédez à la page d'extension Postman sur Chrome Web Store à https: // chrome.Google.com / webstore / détail / Postman / fhbjgbiflinjbdggehcddcbncdddomop?hl = en

Maintenant cliquez sur Ajouter à Chrome.

Maintenant, cliquez sur Ajouter l'application.

Le facteur doit être installé. Maintenant, vous pouvez cliquer sur Démarrer l'application Pour commencer Postman.

Ou, vous pouvez cliquer sur applications.

Et commencer le facteur à partir de là.

Si vous ouvrez Postman pour la première fois, vous devriez voir la fenêtre suivante. Cliquez sur le lien comme marqué dans la capture d'écran ci-dessous si vous n'avez pas de compte ou si vous ne voulez pas vous connecter.

Postman devrait commencer.

Fenêtre principale du facteur:

Vous pouvez également installer Postman nativement sur Linux. C'est hors de l'étendue de cet article. Donc, je ne suis pas en mesure de le montrer ici.

Configuration d'un serveur API de test:

J'ai écrit une API à l'aide de nœud.JS que j'utiliserai dans cet article pour vous montrer comment utiliser Postman pour tester les API. Si vous voulez suivre, vous pouvez simplement cloner mon référentiel GitHub Héro angulaire et exécutez le même serveur API que je suis.

Clone mon référentiel GitHub avec la commande suivante:

$ git clone https: // github.com / shovon8 / hero-héro

Maintenant, accédez à la héros angulaire-API / annuaire:

$ CD Angular-Hero-API /

Maintenant, installez tous les modules de nœud requis:

$ d'installation de NPM

Enfin, démarrez le serveur API avec la commande suivante:

$ test npm

Comme vous pouvez le voir, le serveur API s'exécute sur le port 4242.

Bases du facteur:

Tout d'abord, un facteur ouvert et il devrait ressembler à quelque chose comme ça.

Vous pouvez saisir l'URL de votre point de terminaison API dans la section marquée de la capture d'écran ci-dessous.

Vous pouvez sélectionner la méthode de demande (telle que GET, POST, PUST ETC.) dans le menu déroulant, comme marqué dans la capture d'écran ci-dessous.

Une fois, vous avez terminé, cliquez sur Envoyer Pour envoyer votre demande d'API. Le résultat doit être affiché.

Vous verrez comment tout fonctionne dans la section suivante de cet article.

Utilisation du facteur pour tester les API REST:

Si vous souhaitez effectuer une demande GET sur votre API, saisissez l'URL de votre point de terminaison API, définissez la méthode pour OBTENIR, Et enfin cliquez sur Envoyer.

Par exemple, pour obtenir une liste de tous les héros de la base de données, faites un OBTENIR Demande au serveur API / api / héros point final. Une fois que vous appuyez Envoyer, La sortie doit être affichée au format JSON comme vous pouvez le voir dans la capture d'écran ci-dessous.

Vous pouvez également faire une demande de publication sur votre serveur API à l'aide de Postman. J'ai configuré mon serveur API d'une manière qu'il crée un nouveau héros sur la demande de poste. Pour créer un nouveau héros, définissez la méthode pour POSTE Et le point de terminaison de l'API à / api / héros; Ensuite, cliquez sur Corps comme marqué dans la capture d'écran ci-dessous.

Maintenant, cliquez sur brut et sélectionner JSON (Application / JSON) dans le menu déroulant Type comme marqué dans la capture d'écran ci-dessous.

Enfin, saisissez les informations du héros que vous souhaitez insérer au format JSON et cliquez sur Envoyer.

Comme vous pouvez le voir, le héros est inséré avec l'ID 21.

Toutes vos demandes d'API que vous faites sont enregistrées dans l'histoire du facteur. Pour utiliser une demande API de l'historique, cliquez dessus, puis cliquez sur Envoyer.

Comme vous pouvez le voir, la demande d'API pour répertorier tous les héros que nous avons fait plus tôt est répertorié dans l'histoire. Une fois que vous avez cliqué dessus, il devrait s'ouvrir dans un nouvel onglet. Enfin, cliquez sur Envoyer.

Comme, vous pouvez le voir, tous les héros sont répertoriés, y compris notre nouveau héros.

Vous pouvez également supprimer un héros de la liste en utilisant le SUPPRIMER Méthode sur / api / héros / point final. Ici, est l'ID du héros que vous souhaitez supprimer.

Alors, disons, vous voulez supprimer le héros avec l'ID 20. Ainsi, le point de terminaison de l'API est / api / héros / 20 Et la méthode est SUPPRIMER. Comme vous pouvez le voir, un succès le message est renvoyé. Le héros doit être supprimé.

Comme vous pouvez le voir, le héros avec l'ID 20 est supprimé.

Plus tôt, je vous ai montré comment envoyer des informations au format JSON au serveur API. Ici, je vais vous montrer comment envoyer des informations au format encodé d'URL. Lorsque vous soumettez un formulaire HTML au serveur, c'est le format utilisé par défaut.

Disons que vous souhaitez mettre à jour un héros dans l'API le serveur. Pour ce faire, vous devez utiliser le CORRECTIF Méthode sur / api / héros / Point de terminaison car c'est ce que j'ai configuré dans mon serveur API. Ici le est l'ID du héros que vous souhaitez mettre à jour.

Par exemple, changeons le nom du héros avec l'ID 19 de Magma pour Homme chauve-souris. Donc, le point de terminaison de l'API devrait être / api / héros / 19 et la méthode devrait être CORRECTIF. Maintenant, cliquez sur Corps et également sélectionner x-www-forlencod comme marqué dans la capture d'écran ci-dessous.

Maintenant, définissez la clé pour nom et la valeur de Homme chauve-souris comme marqué dans la capture d'écran ci-dessous. Enfin, cliquez sur Envoyer.

Comme vous pouvez le voir, les données mises à jour s'affichent. Ce qui signifie que l'opération de mise à jour est réussie.

Si vous listez à nouveau tous les héros, vous devriez voir les données mises à jour comme vous pouvez le voir dans la capture d'écran ci-dessous.

Donc, c'est les bases du facteur. Postman a des tonnes de fonctionnalités et d'options que vous pouvez utiliser pour faciliter votre vie en tant que développeur d'API. Merci d'avoir lu cet article. Amusez-vous avec votre facteur!