10.11. Construire une API REST de base avec NodeJS et ExpressJS : documentation de l'API
Page 76 | Écouter en audio
NodeJS, avec ExpressJS, est l'un des outils les plus populaires pour créer des API REST. Dans ce chapitre de notre e-book, nous apprendrons comment créer une API REST de base à l'aide de ces technologies, et également comment documenter l'API pour faciliter son utilisation par d'autres développeurs.
1. Configuration de l'environnement
Tout d'abord, nous devons installer NodeJS et ExpressJS. NodeJS peut être téléchargé et installé depuis le site officiel. Après avoir installé NodeJS, nous pouvons installer ExpressJS à l'aide du gestionnaire de packages npm, qui est installé avec NodeJS. Dans le terminal, exécutez la commande suivante :
2. Création de la structure de base de l'API
Ensuite, créons la structure de base de notre API. Tout d’abord, créez un nouveau fichier appelé app.js. Ce sera le point d’entrée de notre API. Ajoutez le code suivant au fichier :
Ce code crée simplement un nouveau serveur ExpressJS qui écoute sur le port 3000.
3. Ajouter des itinéraires
Les API REST sont basées sur des routes, qui sont des URL représentant différentes ressources. Ajoutons quelques routes de base à notre API. Ajoutez le code suivant au fichier app.js :
Ces routes répondent aux requêtes GET. La première route répond à l'URL de base (/) avec un message de bienvenue. La deuxième route répond à l'URL /users avec une liste factice d'utilisateurs. La troisième route répond à l'URL /users/:id, où :id est un paramètre qui peut avoir n'importe quelle valeur. Cette route renvoie un utilisateur factice avec l'identifiant spécifié.
4. Création d'une base de données factice
Pour rendre notre API un peu plus intéressante, créons une base de données factice d'utilisateurs. Ajoutez le code suivant au fichier app.js :
La route /users renvoie désormais la liste des utilisateurs de notre base de données factice, et la route /users/:id renvoie l'utilisateur avec l'identifiant spécifié, ou une erreur 404 si l'utilisateur n'est pas trouvé.
p >5. Documenter l'API
La documentation est un élément essentiel de toute API. Cela permet à d'autres développeurs de comprendre comment utiliser l'API. Il existe plusieurs outils disponibles pour documenter les API, mais l'un des plus populaires est Swagger. Swagger vous permet de créer une documentation interactive pour votre API qui peut être consultée dans un navigateur Web.
Pour ajouter la documentation Swagger à notre API, nous devons d'abord installer le package swagger-ui-express :
Ensuite, nous pouvons ajouter le code suivant au fichier app.js :
Ce code ajoute la documentation Swagger à la route /api-docs. Le fichier swagger.json contient la documentation de l'API au format JSON. Ce fichier doit être créé manuellement et doit suivre la spécification OpenAPI.
La documentation des API est un sujet complexe qui mérite un chapitre à part entière, mais nous espérons que ce court tutoriel vous a donné une idée sur la façon de créer une API REST de base avec NodeJS et ExpressJS et sur la manière de la documenter. Dans le chapitre suivant, nous explorerons comment ajouter une authentification à notre API.
Répondez maintenant à l’exercice sur le contenu :
Quel est le but de la commande « npm install express --save » mentionnée dans le texte ?
Tu as raison! Félicitations, passez maintenant à la page suivante
Vous avez raté! Essayer à nouveau.
Page suivante de lebook gratuit :
77Construire une API REST de base avec NodeJS et ExpressJS : tests automatisés
4 minutes
Obtenez votre certificat pour ce cours gratuitement ! en téléchargeant lapplication Cursa et en lisant lebook qui sy trouve. Disponible sur Google Play ou App Store !
