Node & Express : Créer une API REST en Javascript
-
Installation5 Chapitres
-
REST API et Express4 Chapitres
-
Structure de l'application4 Chapitres
-
Connecter la base de données PostgreSQL3 Chapitres
-
Créer votre API5 Chapitres
-
Promises et Async call4 Chapitres
-
Gestion des droits des utilisateurs4 Chapitres
-
Construire l'application finale et la déployer en production sur un serveur distant
-
Tester les endpoints avec JEST et SuperTest
-
Améliorer les logs avec morgan et chalk
-
Bonus : VSCode et plugins
Nous allons enfin pouvoir créer notre application. Pour cela nous allons initialiser l’application avec la fonction suivante.
npm init -y
Le flag -y est un raccourci qui valide tous les paramètres par défaut. Si vous ne le mettez pas, il vous demandera les informations une à une pour remplir les informations de votre fichier package.json. Vous pourrez toujours les modifier manuellement par la suite.
Pour installer Express, voici la version la plus classique avec npm :
npm install express --save
J’en profite pour vous montrer la version courte de cette même commande.
npm i express --S
Pour ma part j’utilise Yarn qui joue le même rôle que npm, mais est considéré comme plus rapide grâce à son fonctionnement asynchrone non bloquant.
yarn add express
Nous allons ensuite créer le fichier principal de notre application, la porte d’entrée, index.js à la racine de notre projet.
touch index.js
Vous pouvez également créer ce fichier manuellement. Ensuite nous allons mettre la configuration minimale d’une application Express.
const express = require('express');
const app = express(); // Créé le serveur Express
const PORT = 3000
// Premier endpoint de l'API
app.get('/', (req, res) => {
res.send('Hello World!')
})
app.listen(PORT, () => {
console.log(`🚀 L'application tourne sur le port ${PORT}`)
})Vous pouvez enfin lancer votre première application Express dans votre terminal.
node index.js
Cette commande est en fait assez peu utilisée. On préfère utiliser des commandes du type npm start, npm run dev, npm build etc. Pour cela il faudra modifier le fichier package.json, dans sa partie script.
Ajoutez la ligne start comme ci-dessous.
"scripts": {
"start": "node index.js",
"test": "echo \"Error: no test specified\" && exit 1"
},Vous pouvez ainsi lancer votre commande comme indiqué ci-après. Si votre application précédente tourne toujours, vous pouvez l’arrêter avec Ctrl + c.
npm start
Félicitations, vous avez fait fonctionner votre première application API REST avec Node et Express ! Passons à la suite.