Skip to content

Développement API - Pierre Blarre

Introduction

Icône Présentation
1 / 1

Dans cette partie, nous allons créer un premier serveur web simple qui expose une API REST.

Spécifications :

  • Nous allons utiliser Javascript (Node.js) et Express.js
  • Permettre une authentification basique avec un nom d’utilisateur et un mot de passe
  • Exposer une API REST pour gérer des utilisateurs
  • Stocker les utilisateurs dans un fichier JSON

Express.js

  • Express.js est un framework web minimaliste et flexible pour Node.js qui simplifie la création d’applications web et d’API REST.

  • Il existe de nombreuses alternatives à Express.js, mais Express.js est l’une des plus populaires et des plus utilisées.

  • Le monde du Javascript est en constante évolution et propose régulièrement de nouveaux frameworks et bibliothèques, qui se présentent comme de meilleures alternatives à Express.js.

  • Cependant, Express.js reste un choix sûr et fiable pour la création d’applications web et d’API REST en Javascript.

Préparation du projet

  1. Créez un dossier à l’intérieur du dossier tutoriel-api précédement créé pour stocker les fichiers de ce tutoriel :
cd tutoriel-api
mkdir serveur
cd serveur
  1. Initialiser le projet Nodejs :
npm init

Cette commande va générer le fichier package.json qui contient les informations du projet Node.js. Vous pouvez remplir les informations demandées ou appuyer sur Entrée pour les valeurs par défaut.

  1. Créer un fichier .gitignore pour ignorer les fichiers et dossiers inutiles :
touch .gitignore
  1. Ajouter les dossiers et fichiers à ignorer dans le fichier .gitignore :
.gitignore
node_modules
  1. Créer un commit :
git init
git add .
git commit -m "Initial commit serveur"

Installation des dépendances

Pour le moment, nous n’avons pas encore installé Express.js.

Pour ce faire, nous allons utiliser npm, le gestionnaire de paquets de Node.js.

npm install express

On peut observer que le fichier package.json a été mis à jour avec la dépendance express.

Le serveur

Il est temps de créer notre serveur web avec Express.js.

  1. Créez un fichier index.js à la racine du dossier serveur :
New-Item index.js
  1. Ouvrez le fichier index.js

  2. Ce code va importer Express.js et créer une instance de l’application Express :

import express from 'express';
const app = express();
const port = 3000;
app.listen(port, () => {
console.log(`Server listening at http://localhost:${port}`);
});
app.get('/', (req, res) => {
res.send('Hello World!');
});
  1. Lancez le serveur en exécutant la commande suivante :
node index.js

Vous devriez voir le message Server listening at http://localhost:3000 s’afficher dans la console. Visitez l’adresse http://localhost:3000 dans votre navigateur pour voir le message Hello World!.

Conclusion

Dans cette partie, nous avons :

  • initialisé un projet NodeJS
  • installé Express.js
  • créé un serveur web basique avec Express.js

Dans la prochaine partie, nous allons ajouter des routes supplémentaires à notre application serveur !