La création d'une API REST de base avec NodeJS et ExpressJS est un processus en plusieurs étapes. L'une des étapes les plus importantes consiste à définir des itinéraires qui permettent aux utilisateurs d'interagir avec votre API de différentes manières. Dans cet article, nous verrons comment définir des routes dans votre API à l'aide de NodeJS et ExpressJS.
Pour commencer, il est important de comprendre ce qu'est un itinéraire. En termes simples, une route est un chemin ou une URL auquel les utilisateurs peuvent accéder pour interagir avec votre API. Par exemple, si vous disposez d'une API qui gère une liste de tâches, vous pouvez avoir des routes telles que « /tasks » pour obtenir toutes les tâches, « /tasks/:id » pour obtenir une tâche spécifique, « /tasks » pour en créer une nouvelle. une tâche, et ainsi de suite.
Pour définir des routes dans votre API, vous avez besoin d'ExpressJS, un framework pour NodeJS qui simplifie la création d'API. Pour installer ExpressJS, vous pouvez utiliser npm (Node Package Manager), qui est un outil qui vous permet d'installer des packages NodeJS. . Vous pouvez installer ExpressJS avec la commande suivante :
npm install expressUne fois ExpressJS installé, vous pouvez commencer à définir vos itinéraires. Pour ce faire, vous devez d'abord créer une instance d'Express, puis utiliser les méthodes fournies par cette instance pour définir vos itinéraires. Voici un exemple :
const express = require('express');
const app = express();
app.get('/tasks', (req, res) => {
// Code pour récupérer toutes les tâches
});
app.get('/tasks/:id', (req, res) => {
// Code pour obtenir une tâche spécifique
});
app.post('/tasks', (req, res) => {
// Code pour créer une nouvelle tâche
});
app.écouter(3000, () => {
console.log('API exécutée sur le port 3000');
});
Comme vous pouvez le constater, Express fournit des méthodes telles que « get », « post », « put » et « delete » qui correspondent aux verbes HTTP que les utilisateurs peuvent utiliser pour interagir avec votre API. Chaque méthode accepte une URL (ou une route) et une fonction de rappel qui sera appelée lors de l'accès à la route.
La fonction de rappel prend deux arguments : 'req' et 'res'. 'req' est un objet qui contient des informations sur la requête HTTP effectuée par l'utilisateur, telles que les paramètres d'URL, les données envoyées dans le corps de la requête, les en-têtes de la requête, etc. 'res' est un objet que vous pouvez utiliser pour envoyer une réponse à l'utilisateur.
Par exemple, si vous souhaitez envoyer une liste de tâches à l'utilisateur lorsqu'il accède à la route '/tasks', vous pouvez faire quelque chose comme ceci :
app.get('/tasks', (req, res) => {
tâches const = [
{ identifiant : 1, nom : 'shopping' },
{ id : 2, name : 'Étude pour le test' },
//...
];
res.json(tâches);
});
Dans l'exemple ci-dessus, 'res.json' est une méthode qui convertit le tableau 'tasks' en une chaîne JSON et l'envoie à l'utilisateur en réponse.
La définition de routes dans votre API est une partie cruciale du processus de création d'une API avec NodeJS et ExpressJS. Une fois les itinéraires définis, les utilisateurs peuvent interagir avec votre API de différentes manières, en obtenant des données, en envoyant des données, en mettant à jour des données et en supprimant des données. Lorsque vous définissez vos itinéraires, n'oubliez pas de bien réfléchir aux itinéraires dont vous avez besoin et aux données que vous devez envoyer et recevoir sur chaque itinéraire.
