Nœud.js est un runtime Javascript basé sur le moteur Javascript V8 de Chrome. Node est conçu pour créer des applications réseau évolutives. Notre objectif dans cet article est de créer une API REST à l’aide de Node.js. Nous allons créer un service de calculatrice simple qui fera des calculs de base et renverra les sorties générées.
Qu’est-ce qu’une API REST ?
Simplement une API RESTful est une interface de programmation d’applications (API) qui utilise une requête HTTP pour OBTENIR, PUBLIER, METTRE, SUPPRIMER des données. Également connu sous le nom de services Web RESTful. REST signifie Transfert d’État représentatif, qui est un style architectural pour le développement de services Web.
Ce que nous allons construire ?
Nous allons créer un service Web simple qui fera des calculs et renverra les valeurs. Les URL de demande et la sortie ressembleront à ceci.
Ce dont vous avez besoin
- Un joli petit éditeur de code comme Visual Studio Code.
- Nœud.js installé dans votre système.
- Un cadre de service — Dans cet article, j’utilise hapi.js (prononcé comme Happy JS)
- Une application comme POSTMAN (une extension d’application chrome) pour tester notre service.
Je suis dans macOS High Sierra version 10.13.3. Les commandes shell doivent être similaires sur d’autres plates-formes.
Commençons
Cliquez ici pour obtenir l’échantillon de travail complet.
Tout d’abord, vous devez vérifier la version de Node.js vous avez. Permet d’ouvrir un terminal et de taper la commande suivante pour vérifier la version du nœud.js vous avez. J’utilise la version 8.9.4
$ node --version
D’accord, créez maintenant un répertoire pour stocker votre code et naviguez-y en utilisant les commandes shell suivantes.
$ mkdir calc-service
$ cd calc-service
Permet de créer un projet.fichier json, en tapant cette commande.
$ npm init
Répondez aux questions et à votre projet.le fichier json devrait ressembler à ceci.
Bien, maintenant nous avons créé la base de notre nœud.service js. Ensuite, nous devons installer le hapi.cadre js. hapi.js est un framework riche qui vous permet de créer des applications Web ainsi que des services basés sur Node.js.
Permet d’aller sur le terminal et de taper et d’entrer la commande suivante.
$ npm install --save [email protected]
npm est un gestionnaire de paquets qui vous permet d’installer des milliers de modules pour travailler avec Node.js. Si vous regardez la commande ci-dessus, nous avons demandé au npm d’installer hapi version 17. Nous avons également demandé de mettre à jour le package.fichier json en utilisant l’option enregistrer.
Maintenant, la structure de votre dossier devrait ressembler à ceci.
Comme vous voyez le hapi.la dépendance js a été mise à jour dans le package.le fichier json ainsi que les node_modules requis sont mis à jour.
Permet de créer le serveur maintenant
Dans cette étape, nous allons chercher à créer un serveur qui écoutera nos demandes. Dans le terminal, tapez la commande suivante pour créer le serveur.fichier js. Cela doit être à la racine du répertoire dans lequel vous vous trouvez. Ou vous pouvez utiliser un nouveau fichier dans l’onglet du volet de gauche dans VS Code.
$ touch server.js
Permet d’ajouter le code suivant dans le serveur.fichier js. Ce code créera du code qui écoutera les demandes des utilisateurs sur un port donné.
Permet de vérifier si le serveur est opérationnel. Ouvrez le terminal et la commande suivante.
$ node server.js
Et vous devriez voir une sortie comme celle-ci.
Créez notre première route
Maintenant, nous avons testé avec succès le serveur. Notre serveur est opérationnel maintenant. Il est temps de créer le premier itinéraire. Commençons simplement en créant ce chemin.
/calculator/about
Ouvrez le serveur.fichier js et ajoutez le code suivant, juste avant init().
Le code ci-dessus crée une route vers un chemin de /calculator/ à propos de l’utilisation d’une méthode GET. Dans le gestionnaire de ligne 4, la fonction gère la demande et renvoie une réponse en tant que réponse. Dans la ligne 5, nous avons créé une variable qui stocke une chaîne JSON. Enfin, line renvoie cette variable en tant que réponse du serveur.
Maintenant, nous avons ajouté notre première route vers le serveur. Permet d’avoir un test rapide sur le nouveau code. Dans le terminal, tapez la commande suivante pour démarrer le serveur. (Vous pouvez arrêter le serveur en appuyant sur CTRL + C)
$ node server.js
Permet de déclencher le FACTEUR et de tester notre premier itinéraire.
Comme vous le voyez, nous avons utilisé la méthode GET pour envoyer la requête et l’URL correspond au chemin de la route. Nous avons un retour réussi du serveur sous forme de chaîne JSON.
Excellent nous avons un code de travail en ce moment. C’est une bonne pratique d’organiser un peu un code. Même s’il s’agit d’une petite application, c’est toujours une bonne pratique de le faire. Permet de déplacer notre code de routage dans un dossier et un fichier séparés.
Permet d’arrêter d’abord le serveur en appuyant sur CTRL +C dans le terminal. Et dans le répertoire racine, créez un répertoire nommé routes. Utilisez les commandes suivantes dans le terminal ou vous pouvez le créer à l’aide du code VS.
$ mkdir routes
$ cd routes
$ touch routes.js
Maintenant, la structure du répertoire devrait ressembler à ceci.
Ouvrez maintenant la route.fichier js à l’intérieur du code VS. Ensuite, coupez le code que nous avons écrit pour le routage sur le serveur.fichier js. Et collez à l’intérieur de la route.fichier js. Maintenant, ouvrez à nouveau le serveur.fichier js ajoutez le code suivant juste avant l’appel de la méthode init().
require(‘./routes/routes’)(server);
Maintenant, nous avons un code un peu organisé. Permet d’ajouter le reste des itinéraires aux itinéraires.fichier js.
Maintenant, toutes nos routes sont intactes. Si vous regardez les numéros de ligne 19, 36, 53 et 70, le chemin comporte deux entrées entre parenthèses {}. Ceux-ci sont traités comme des paramètres dans le chemin. Vous pouvez accéder à ces paramètres comme indiqué aux lignes 22 et 23. Le repos est explicite.
Permet maintenant de démarrer le serveur en tapant cette commande dans le terminal et de la tester à l’aide de POSTMAN.
$ node server.js
Congratulations. You have written your first Node.js based REST API service.
Happy Coding 🙂 !!!