Skip to content

Développement API - Pierre Blarre

Routes

Icône Présentation
1 / 1

Les routes sont des points d’entrée pour les requêtes HTTP.

Elles permettent de définir des actions à effectuer en fonction de l’URL demandée.

Les routes dans Express.js

Pour créer une route avec Express.js, on utilise la méthode app.METHOD(PATH, HANDLER).

  • app est une instance d’Express.
  • METHOD est une méthode HTTP (GET, POST, PUT, DELETE, etc.).
  • PATH est un chemin sur le serveur.
  • HANDLER est une fonction qui sera exécutée lorsque la route est demandée.

Dans notre fichier index.js créé précédement, nous avions déjà ajouté une route pour la racine du serveur :

app.get('/', (req, res) => {
res.send('Hello World!')
})

Dans cet exemple, la route /, capturé par une requête HTTP GET, est associée à une fonction qui renvoie la chaîne de caractères Hello World!.

  • req est l’objet de la requête HTTP (request) reçue par le serveur depuis le client
  • res est l’objet de la réponse HTTP (response) envoyée par le serveur vers le client.

Une nouvelle route pour notre serveur

Ajoutons une nouvelle route à notre serveur qui cette fois renvoie un objet JSON :

app.get('/api', (req, res) => {
res.json({ message: 'Hello World JSON!' })
})

Dans cet exemple, la route /api, capturée par une requête HTTP GET, est associée à une fonction qui renvoie un objet JSON.

Il faut redémarrer le serveur pour que les modifications soient prises en compte.

Si vous visitez http://localhost:3000/api dans votre navigateur, vous devriez voir le message {"message":"Hello World JSON!"}.

Et voilà, vous avez créé votre première API REST avec Express.js ! Bravo !

nodemon

Pour éviter de redémarrer manuellement le serveur à chaque modification, on peut utiliser le paquer nodemon (pour “node monitor”).

nodemon est un outil qui surveille (watch) les modifications dans les fichiers d’un projet Node.js et recharge automatiquement le serveur à chaque modification d’un fichier source.

Installation

Pour installer nodemon globalement sur votre système, exécutez la commande suivante :

npm install -g nodemon

Ici, l’option -g permet d’installer nodemon globalement sur votre système.

Pour installer nodemon localement dans votre projet, exécutez la commande suivante :

npm install -D nodemon

Utilisation

Désormais, pour lancer le serveur en développement, on n’utilisera plus node mais nodemon :

nodemon index.js

On peut aussi modifier la section scripts du fichier package.json pour lancer le serveur avec nodemon :

package.json
"scripts": {
"start": "nodemon index.js"
}

Avec cette modification, on peut maaintenant lancer le serveur avec la commande npm start.

Postman

Postman est un outil de test d’API qui permet de tester les requêtes HTTP.

Il est très utile pour tester les routes de notre serveur.

Pour tester notre route /api, vous pouvez utiliser Postman pour envoyer une requête HTTP GET à http://localhost:3000/api.

Installation

Pour installer Postman, rendez-vous sur le site officiel de Postman et téléchargez la version adaptée à votre système d’exploitation.

Utilisation

  1. Ouvrez Postman.
  2. Créez une nouvelle requête.
  3. Entrez l’URL de votre serveur (par exemple, http://localhost:3000/api).
  4. Choisissez la méthode HTTP GET.
  5. Cliquez sur le bouton “Send”.

Vous devriez voir le message {"message":"Hello World JSON!"} dans la réponse.

Postman

Conclusion

  • Dans ce tutoriel, nous avons vu comment créer des routes dans Express.js.
  • Les routes sont des points d’entrée pour les requêtes HTTP.
  • Elles permettent de définir des actions à effectuer en fonction de l’URL demandée.
  • Nous avons créé une nouvelle route /api qui renvoie un objet JSON.
  • Nous avons également vu comment tester notre route avec Postman.

Dans la sections suivante, nous allons utiliser le générateur d’applications Express.js pour créer une application Express.js plus complexe.