Scribd
Importer
21 vues2 pages

API REST CRUD avec Node.js et Postman

Ce document décrit la création d'une API REST CRUD utilisant Node.js et Express pour gérer des données dans un fichier JSON. Il couvre la mise en place d'un serveur, le parsing JSON, la gestion des données, la création des endpoints pour les opérations CRUD, ainsi que les tests de l'API avec Postman. Enfin, il propose de documenter l'API en listant les endpoints et en fournissant des captures d'écran des tests.

Transféré par

Asmaë Asmaë
Copyright
© All Rights Reserved
Nous prenons très au sérieux les droits relatifs au contenu. Si vous pensez qu’il s’agit de votre contenu, signalez une atteinte au droit d’auteur ici.
Formats disponibles
Téléchargez aux formats PDF, TXT ou lisez en ligne sur Scribd
21 vues2 pages

API REST CRUD avec Node.js et Postman

Ce document décrit la création d'une API REST CRUD utilisant Node.js et Express pour gérer des données dans un fichier JSON. Il couvre la mise en place d'un serveur, le parsing JSON, la gestion des données, la création des endpoints pour les opérations CRUD, ainsi que les tests de l'API avec Postman. Enfin, il propose de documenter l'API en listant les endpoints et en fournissant des captures d'écran des tests.

Transféré par

Asmaë Asmaë
Copyright
© All Rights Reserved
Nous prenons très au sérieux les droits relatifs au contenu. Si vous pensez qu’il s’agit de votre contenu, signalez une atteinte au droit d’auteur ici.
Formats disponibles
Téléchargez aux formats PDF, TXT ou lisez en ligne sur Scribd

TP4 : Création d'une API REST CRUD sur un fichier

JSON et tests avec Postman

Objectifs
●​ Comprendre le concept d'API REST et ses composants (routes/endpoints,
méthodes HTTP, requêtes/réponses).
●​ Créer un serveur avec Express en [Link].
●​ Implémenter les opérations CRUD (Create, Read, Update, Delete) pour gérer
des données stockées dans un fichier JSON.
●​ Tester l'API avec Postman pour s'assurer que toutes les routes fonctionnent
correctement.

Créez un serveur Express :

●​ Votre serveur doit écouter sur un port (par exemple, le port 3000).
●​ Il doit afficher un message dans la console lorsque le serveur démarre.

Implémentez le parsing JSON :

●​ Configurez Express pour qu'il puisse lire le corps des requêtes en JSON (par
exemple, via le middleware intégré [Link]()).

Gérez les données avec un fichier JSON :

●​ Créez un fichier (par exemple, [Link]) qui servira de stockage pour vos
données. Ce fichier doit être initialisé avec un tableau vide ([]).
●​ Implémentez des fonctions qui permettent de lire et d'écrire dans ce fichier en
utilisant le module fs de [Link].
●​ Assurez-vous que les opérations de lecture/écriture traitent correctement les erreurs
potentielles (par exemple, si le fichier n'existe pas ou est corrompu).

Créez les endpoints pour les opérations CRUD :

●​ GET /items : doit renvoyer la liste complète des éléments présents dans le fichier
JSON.
●​ GET /items/:id : doit renvoyer un élément spécifique identifié par son ID. Si l'élément
n'existe pas, renvoyez un code 404 avec un message d'erreur approprié.
●​ POST /items : doit permettre de créer un nouvel élément. L'ID peut être attribué
automatiquement (par exemple, en utilisant la longueur du tableau + 1).
●​ PUT /items/:id : doit permettre de mettre à jour un élément existant en se basant sur
l'ID fourni dans l'URL. Si l'élément n'existe pas, renvoyez un code 404.
●​ DELETE /items/:id : doit supprimer un élément existant identifié par son ID. Vérifiez
également que l'élément existe avant de le supprimer.

Testez votre API avec Postman :

●​ GET : Ouvrez Postman et créez une requête GET vers


[Link] Vérifiez que vous obtenez un tableau JSON.
●​ POST : Créez une requête POST vers [Link] avec un
corps JSON (ex. : { "name": "Premier item", "description":
"Description de l'item" }). Vérifiez que l'élément est ajouté et que l'API
renvoie le nouvel élément avec un ID.
●​ GET par ID : Testez l'endpoint GET pour un élément spécifique (ex.
[Link] et vérifiez la réponse.
●​ PUT : Créez une requête PUT pour modifier un élément existant. Par exemple,
mettez à jour l'item avec ID 1 en changeant sa propriété "name".
●​ DELETE : Testez la suppression d'un élément via DELETE (ex.
[Link] et vérifiez que l'élément est retiré.

Documentez votre API :

●​ Rédigez un petit document ou un tableau qui liste tous les endpoints, la méthode
HTTP associée, les paramètres attendus (par exemple, dans le corps de la requête
pour POST et PUT), et la structure des réponses attendues.
●​ Fournissez des captures d'écran de vos tests avec Postman.

Vous aimerez peut-être aussi