Les APIs (Interfaces de Programmation d’Application) RESTful sont des services web populaires qui utilisent les principes de l’architecture REST (Representational State Transfer) pour permettre à différentes applications de communiquer entre elles. Dans ce tutoriel, nous allons créer une API RESTful simple en utilisant Node.js et Express, une bibliothèque populaire pour le développement web en JavaScript.

Prérequis

Avant de commencer, assurez-vous que vous avez les éléments suivants installés sur votre machine :

• Node.js : Vous pouvez télécharger Node.js depuis le site officiel.
• npm (Node Package Manager) : npm est installé automatiquement avec Node.js et permet de gérer les dépendances de votre projet.

Étape 1 : Initialiser votre projet

Tout d’abord, créez un nouveau dossier pour votre projet et initialisez-le avec npm :

mkdir rest-api-example
cd rest-api-example
npm init -y

Cela va créer un fichier package.json qui contient les informations de votre projet.

Étape 2 : Installer les dépendances

Nous allons installer Express, le framework web qui facilitera la création de notre API :

npm install express

Étape 3 : Créer le serveur Express

Une fois Express installé, nous pouvons commencer à créer notre API. Créez un fichier nommé app.js à la racine de votre projet et ouvrez-le dans votre éditeur de texte préféré. Ajoutez le code suivant pour configurer un serveur de base avec Express :

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

app.use(express.json()); // Pour analyser les données JSON dans les requêtes

// Route GET pour récupérer un message
app.get('/', (req, res) => {
  res.send('Bienvenue sur votre API RESTful!');
});

// Démarrer le serveur
app.listen(port, () => {
  console.log(`Serveur en écoute sur http://localhost:${port}`);
});

Ici, nous avons configuré un serveur de base qui écoute sur le port 3000 et répond à une requête GET à la racine / avec un message simple.

Étape 4 : Créer des routes RESTful

Maintenant que nous avons configuré le serveur, nous allons créer plusieurs routes RESTful pour illustrer les opérations courantes d’une API :

1. GET : Récupérer des données.
2. POST : Créer des données.
3. PUT : Mettre à jour des données.
4. DELETE : Supprimer des données.

Ajoutez les routes suivantes dans votre fichier app.js :

// Liste des utilisateurs fictifs
let users = [
  { id: 1, name: 'John Doe' },
  { id: 2, name: 'Jane Smith' }
];

// Route GET pour récupérer la liste des utilisateurs
app.get('/users', (req, res) => {
  res.json(users);
});

// Route GET pour récupérer un utilisateur par ID
app.get('/users/:id', (req, res) => {
  const user = users.find(u => u.id === parseInt(req.params.id));
  if (!user) return res.status(404).send('Utilisateur non trouvé');
  res.json(user);
});

// Route POST pour ajouter un nouvel utilisateur
app.post('/users', (req, res) => {
  const user = {
    id: users.length + 1,
    name: req.body.name
  };
  users.push(user);
  res.status(201).json(user);
});

// Route PUT pour mettre à jour un utilisateur existant
app.put('/users/:id', (req, res) => {
  const user = users.find(u => u.id === parseInt(req.params.id));
  if (!user) return res.status(404).send('Utilisateur non trouvé');
  
  user.name = req.body.name;
  res.json(user);
});

// Route DELETE pour supprimer un utilisateur
app.delete('/users/:id', (req, res) => {
  const userIndex = users.findIndex(u => u.id === parseInt(req.params.id));
  if (userIndex === -1) return res.status(404).send('Utilisateur non trouvé');
  
  users.splice(userIndex, 1);
  res.status(204).send();
});

Voici ce que chaque route fait :

• GET /users : Récupère tous les utilisateurs.
• GET /users/:id : Récupère un utilisateur spécifique par ID.
• POST /users : Crée un nouvel utilisateur avec le nom envoyé dans la requête.
• PUT /users/:id : Met à jour l’utilisateur spécifié par ID avec les données envoyées dans la requête.
• DELETE /users/:id : Supprime l’utilisateur spécifié par ID.

Étape 5 : Tester l’API

Vous pouvez maintenant tester votre API en utilisant un outil comme Postman ou cURL pour envoyer des requêtes HTTP à votre serveur.

1. GET /users : Récupère tous les utilisateurs. curl http://localhost:3000/users
2. POST /users : Crée un nouvel utilisateur.curl -X POST http://localhost:3000/users -H "Content-Type: application/json" -d '{"name": "Alice Johnson"}'
3. GET /users/:id : Récupère un utilisateur par ID. curl http://localhost:3000/users/1
4. PUT /users/:id : Met à jour un utilisateur. curl -X PUT http://localhost:3000/users/1 -H "Content-Type: application/json" -d '{"name": "Johnathan Doe"}'
5. DELETE /users/:id : Supprime un utilisateur. curl -X DELETE http://localhost:3000/users/1

Conclusion

Félicitations ! Vous avez créé une simple API RESTful avec Node.js et Express. Vous pouvez maintenant étendre cette API en ajoutant des fonctionnalités telles que la gestion des erreurs, la validation des données, ou la connexion à une base de données pour stocker les informations de manière persistante.

Les APIs RESTful sont un excellent moyen de créer des services web évolutifs et faciles à intégrer dans des applications front-end. En maîtrisant cette architecture, vous pourrez concevoir des APIs robustes pour divers types d’applications.