Test de l'API REST avec Postman PDF

Test de l’API REST avec Postman Notre source de données est le fichier equipes.json contenant des Équipes. Chaque équipe dispose des champs id, name, country =>Placer ce fichier dans la racine de votre projet. Afin de tester nos api rest, nous allons installer l’outil Postma...

Test de l’API REST avec Postman Notre source de données est le fichier equipes.json contenant des Équipes. Chaque équipe dispose des champs id, name, country =>Placer ce fichier dans la racine de votre projet. Afin de tester nos api rest, nous allons installer l’outil Postman Copyright - Tout droit réservé - OFPPT 77 Test de l’API REST avec Postman Postman, c'est quoi ? Postman est officiellement présentée comme une plateforme API pour la création et l’utilisation d’API. D’une manière générale, Postman est une plateforme qui permet de simplifier chaque étape du cycle de vie des API et de rationaliser la collaboration, afin de créer, plus facilement et plus rapidement, de meilleures API. Pourquoi utiliser Postman ? La plupart des utilisateurs de Postman recourent à cette plateforme pour la construction et la formulation de requêtes, afin de tester des API sans avoir à renseigner de code. Parmi les nombreux points forts de Postman, on relève : ✓ la possibilité d’utiliser la plateforme, quel que soit le langage utilisé pour la programmation des API ; ✓ une interface utilisateur assez simple et facile à prendre en main ; ✓ l’absence de compétences nécessaires en codage. Copyright - Tout droit réservé - OFPPT 78 Test de l’API REST avec Postman Comment marche Postman ? Le fonctionnement de Postman se résume le plus souvent à formuler une requête en suivant la structure spécifique (Verbe http + URI + Version http + Headers + Body) puis à obtenir une réponse. Le code de réponse HTTP délivré par la plateforme informe ensuite le développeur du statut de la réponse : "200 OK" pour une requête réussie, "404 Not Found" pour un échec, etc. Comment télécharger Postman ? Postman est compatible avec les différents systèmes d’exploitation (Linux, Windows et OS X). Pour télécharger Postman, il suffit de se rendre sur le site internet officiel de la plateforme. https://www.postman.com/downloads/ Copyright - Tout droit réservé - OFPPT 79 Test de l’API REST avec Postman Etant donné que nous n’avons aucune route configuré, sur le navigateur, si on tape 127.0.0.1:80: on aura le message d’erreur suivant: Une fois que le serveur est lancé, on pourra développer nos API Rest, deux étapes sont nécessaires : 1-Les ressources (fichiers json, bases de données Mongodb ou mysql….) 2-Les routes : (les chemins pour récupérer , ajouter, modifier et supprimer les données disponibles dans nos ressources) Copyright - Tout droit réservé - OFPPT 80 Test de l’API REST avec Postman Etape 2 : Route GET /equipes : Ajoutons le bout de code suivant: Le framework Express Nous propose des méthode get,post,put delete pour manipuler Les data ➔faites ctrl + c : pour Annuler le serveur puis relancer Node index.js Copyright - Tout droit réservé - OFPPT 81 Test de l’API REST avec Postman Etape 2 : Route GET / equipes Avec POSTMAN, on va créer une collection pour nos 4 requetes Copyright - Tout droit réservé - OFPPT 82 Test de l’API REST avec Postman Etape 2 : Route GET / equipes Afin de récupérer les données, ajoutons la ligne de code suivante Nous avons remplacé la méthode send par la méthode json En effet notre API REST va retourner un fichier JSON au client Et non pas du texte ou un fichier html Nous avons également Ajouté le statut 200 qui correspond au code réponse http Indiquant au client que sa requête s’est terminée avec succès Copyright - Tout droit réservé - OFPPT 83 Test de l’API REST avec Postman Etape 2 : Route GET / equipes/:id La requette suivante est aussi une requête GET avec un paramètre «id» Copyright - Tout droit réservé - OFPPT 84 Test de l’API REST avec Postman Rappel des Middlewares :Les middlewares sont des fonctions qui s'exécutent lors de la requête au serveur. Ces fonctions ont accès aux paramètres de la requête et de la réponse et peuvent donc effectuer beaucoup de choses pour améliorer/automatiser les fonctionnalités de l'API Le middleware se situe entre la requête et la réponse : user request -> midlleware -> response La requête suivante est POST permettant de poster des Data vers le serveur Pour récupérer les données passées dans la requête POST, nous devons ajouter un middleware à notre Node JS API afin qu’elle soit capable d’interpréter le body de la requête Ce middleware va se placer entre l’arrivée de la requête et nos routes et exécuter son code, rendant possible l’accès au body Copyright - Tout droit réservé - OFPPT 85 Test de l’API REST avec Postman Route POST /equipes/ Au niveau POSTMAN, il faut envoyer un objet JSON Copyright - Tout droit réservé - OFPPT 86 Test de l’API REST avec Postman Route PUT / equipes /:id Pour la requête PUT on doit spécifier comme paramètre l’id de l’objet à modifier Copyright - Tout droit réservé - OFPPT 87 Test de l’API REST avec Postman Route PUT / equipes /:id On peut vérifier que la liste a été mis à jour Copyright - Tout droit réservé - OFPPT 88 Test de l’API REST avec Postman Route DELETE / equipes /:id Enfin, la requête Delete permettant de supprimer un objet de la liste Copyright - Tout droit réservé - OFPPT 89 Test de l’API REST avec Postman Exercice Considérer la ressource joueurs.json Chaque joueur dispose des champs(id, idEquipe,nom,numero,poste) 1-Développer les opérations crud pour l’entité joueur(4 requetes) 2-Développer la route permettant d’afficher les joueurs d’une équipe via son id(de l’équipe). 3-Développer la route permettant d’afficher l’équipe d’un joueur donné via son id. 4-Développer la route permettant de chercher un jour a partir de son nom Copyright - Tout droit réservé - OFPPT 90