Créer une API REST avec Node.js et Express

Dans le monde du développement web, les API REST jouent un rôle crucial en permettant aux différentes applications de communiquer entre elles. Si vous souhaitez créer une API REST avec Node.js et Express, vous êtes au bon endroit. Cet article vous guidera à travers les étapes nécessaires pour mettre en place votre propre API REST, avec des exemples de code et des explications claires.

Qu'est-ce qu'une API REST ?

Une API (Application Programming Interface) REST (Representational State Transfer) est un ensemble de règles qui permettent à des applications de communiquer entre elles via le protocole HTTP. Les API REST utilisent les méthodes HTTP comme GET, POST, PUT et DELETE pour interagir avec les données. Elles sont largement utilisées en raison de leur simplicité et de leur efficacité.

Pré-requis

Avant de commencer, assurez-vous d'avoir installé Node.js et npm (Node Package Manager) sur votre machine. Vous pouvez vérifier leur installation en exécutant les commandes suivantes :

node -v
npm -v

Si ces commandes retournent une version, vous êtes prêt à commencer. Sinon, téléchargez et installez Node.js depuis le site officiel.

Créer un projet Node.js

Pour créer votre projet, commencez par créer un dossier pour votre API et naviguez à l'intérieur de celui-ci :

mkdir mon-api
cd mon-api

Ensuite, initialisez un nouveau projet Node.js avec npm :

npm init -y

Cela créera un fichier package.json dans votre dossier. Maintenant, vous devez installer Express, un framework web pour Node.js qui facilite la création d'applications web et d'API :

npm install express

Configurer votre serveur Express

Créez un fichier nommé app.js dans votre dossier de projet. Ce fichier contiendra la configuration de votre serveur Express. Ajoutez le code suivant :

const express = require('express');
const app = express();
const port = 3000;

app.use(express.json()); // Middleware pour parser le JSON

app.get('/', (req, res) => {
    res.send('Bienvenue sur mon API REST !');
});

app.listen(port, () => {
    console.log(`Serveur en cours d'exécution sur http://localhost:${port}`);
});

Ce code crée un serveur qui écoute sur le port 3000 et renvoie un message de bienvenue lorsque vous accédez à la racine de l'API.

Ajouter des routes pour votre API

Maintenant que votre serveur est configuré, vous pouvez ajouter des routes qui géreront les différentes requêtes HTTP. Supposons que vous souhaitiez gérer une liste de tâches. Voici comment vous pouvez ajouter des routes pour créer, lire, mettre à jour et supprimer des tâches :

let tasks = [];

app.get('/tasks', (req, res) => {
    res.json(tasks);
});

app.post('/tasks', (req, res) => {
    const task = req.body;
    tasks.push(task);
    res.status(201).json(task);
});

app.put('/tasks/:id', (req, res) => {
    const { id } = req.params;
    const taskIndex = tasks.findIndex(t => t.id === parseInt(id));
    if (taskIndex !== -1) {
        tasks[taskIndex] = req.body;
        res.json(tasks[taskIndex]);
    } else {
        res.status(404).json({ message: 'Tâche non trouvée' });
    }
});

app.delete('/tasks/:id', (req, res) => {
    const { id } = req.params;
    tasks = tasks.filter(t => t.id !== parseInt(id));
    res.status(204).send();
});

Avec ce code, vous avez ajouté des routes pour gérer les tâches. Vous pouvez récupérer toutes les tâches, en ajouter de nouvelles, mettre à jour des tâches existantes et les supprimer.

Tester votre API

Pour tester votre API, vous pouvez utiliser des outils comme Postman ou curl. Voici quelques exemples de commandes curl que vous pouvez utiliser :

# Ajouter une tâche
curl -X POST http://localhost:3000/tasks -H "Content-Type: application/json" -d '{"id": 1, "name": "Faire les courses"}'

# Obtenir toutes les tâches
curl http://localhost:3000/tasks

# Mettre à jour une tâche
curl -X PUT http://localhost:3000/tasks/1 -H "Content-Type: application/json" -d '{"id": 1, "name": "Faire les courses et le ménage"}'

# Supprimer une tâche
curl -X DELETE http://localhost:3000/tasks/1

Ces commandes vous permettront de tester les différentes routes de votre API.

Conclusion

Vous avez maintenant les connaissances nécessaires pour créer une API REST simple avec Node.js et Express. En suivant cet article, vous avez appris à configurer votre serveur, à ajouter des routes et à tester votre API. Les possibilités sont infinies ! N'hésitez pas à étendre cette API avec des fonctionnalités supplémentaires comme la gestion des utilisateurs, l'authentification, ou la connexion à une base de données.

Si cet article vous a été utile, partagez-le avec vos amis et collègues. Pour aller plus loin, consultez notre site pour découvrir d'autres ressources sur le développement web !