Créer une API RESTful avec Node.js | Tutoriel Express.js

Introduction

Dans ce projet, vous allez apprendre à développer une API RESTful à l'aide de Node.js et d'Express.js. Le projet consiste à créer un système de gestion d'utilisateurs simple, où vous pouvez récupérer une liste d'utilisateurs.

👀 Aperçu

curl http://localhost:8080/list
## Sortie :
## {"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

🎯 Tâches

Dans ce projet, vous allez apprendre :

Comment configurer un projet Node.js et installer les dépendances
Comment créer un serveur Express.js de base
Comment implémenter un point d'accès GET pour récupérer une liste d'utilisateurs à partir d'un fichier JSON
Comment tester l'API à l'aide de cURL

🏆 Réalisations

Après avoir terminé ce projet, vous serez capable de :

Comprendre les bases du développement d'API RESTful
Configurer un projet Node.js et installer les dépendances nécessaires
Créer un serveur Express.js simple
Implémenter un point d'accès GET pour récupérer des données à partir d'un fichier JSON
Tester l'API à l'aide de cURL

Configurer le projet

Dans cette étape, vous allez configurer le projet et installer les dépendances nécessaires.

Le code initial de cette question a déjà été fourni. Ouvrez l'environnement de codage, et la structure de répertoire est la suivante :

├── index.js
├── users.json
├── package.json
├── package-lock.json

Ensuite, téléchargez les dépendances à l'aide de la commande npm install dans le terminal, attendez que les dépendances aient fini de se télécharger puis lancez le projet à l'aide de la commande npm run dev.

Implémenter le point d'accès GET /list

Dans cette étape, vous allez implémenter le point d'accès GET /list pour afficher la liste des utilisateurs.

Ouvrez le fichier index.js dans le répertoire du projet.
Localisez la section TODO dans le fichier et ajoutez le code suivant pour implémenter le point d'accès GET /list :

//TODO
app.get("/list", function (req, res) {
  fs.readFile(
    path.resolve(__dirname, "./users.json"),
    "utf8",
    function (err, data) {
      data = JSON.parse(data);
      res.json(data);
    }
  );
});

Ce code lit le fichier users.json, analyse les données JSON et les envoie en réponse.

Enregistrez le fichier index.js.

Tester le point d'accès GET /list

Dans cette étape, vous allez tester le point d'accès GET /list pour vous assurer qu'il fonctionne correctement.

Ouvrez un nouveau terminal dans l'environnement de laboratoire.
Utilisez la commande curl pour envoyer une requête GET au point d'accès /list :

curl http://localhost:8080/list

Vous devriez voir la sortie suivante, qui est les données JSON du fichier users.json :

{"userlist":[{"id":"1","username":"zhangsan","password":"123456"},{"id":"2","username":"lilei","password":"456"},{"id":"3","username":"hanmeimei","password":"123"}]}

Si vous voyez cette sortie, le point d'accès GET /list fonctionne correctement.

Félicitations ! Vous avez terminé le projet et implémenté le point d'accès GET /list pour afficher la liste des utilisateurs.

Résumé

Félicitations ! Vous avez terminé ce projet. Vous pouvez pratiquer plus de laboratoires dans LabEx pour améliorer vos compétences.

Création d'une API RESTful de gestion d'utilisateurs avec Node.js