Création d'une API REST avec Node.js et une base de données Oracle

Bonjour, Habr! Je vous présente la traduction de l'article «Création d'une API REST: bases du serveur Web» .

Partie 1. Création d'une API REST: principes de base du serveur Web

Le serveur Web est l'un des composants les plus importants de l'API REST. Dans cet article, vous commencerez votre projet d'API REST en créant des répertoires et des fichiers initiaux. Ensuite, vous allez créer un module de serveur Web et le brancher pour que le serveur Web démarre et s'arrête correctement.

Le code de ce projet sera organisé en utilisant une structure de répertoire commune, qui peut être ajustée et construite au fil du temps si nécessaire.

cd ~ mkdir hr_app cd hr_app/ touch index.js mkdir config touch config/web-server.js mkdir controllers mkdir db_apis mkdir services touch services/web-server.js 

Le fichier index.js peut être considéré comme le fichier "principal" de l'application. Ce sera le point d'entrée de l'application. Nous ajouterons du code à ce fichier et aux fichiers web-server.js dans les répertoires config et services.

Collez le code suivant dans le fichier Accueil> hr_app> config> web-server.js

 module.exports = { port: process.env.HTTP_PORT || 3000 }; 

Dans Node.js, un objet de processus a une propriété env qui contient un environnement utilisateur. J'utilise ceci pour définir la valeur du port sur la valeur de la variable d'environnement HTTP_PORT. Si cette variable d'environnement n'est pas définie, la valeur par défaut est 3000.

Collez le code suivant dans le fichier Home> hr_app> services> web-server.js

 const http = require('http'); const express = require('express'); const webServerConfig = require('../config/web-server.js'); let httpServer; function initialize() { return new Promise((resolve, reject) => { const app = express(); httpServer = http.createServer(app); app.get('/', (req, res) => { res.end('Hello World!'); }); httpServer.listen(webServerConfig.port) .on('listening', () => { console.log(`Web server listening on localhost:${webServerConfig.port}`); resolve(); }) .on('error', err => { reject(err); }); }); } module.exports.initialize = initialize; 

Lignes 1 à 3: plusieurs modules requis. Le module http est inclus dans Node.js, mais le module Express devra être installé via npm.

Lignes 7-27: Une fonction nommée initialize est déclarée. La fonction renvoie immédiatement une promesse, qui est autorisée ou refusée selon que le serveur Web a été correctement lancé.

Lignes 9-10: Une nouvelle application express est créée (qui n'est en fait qu'une fonction) puis utilisée pour créer un serveur http via le module http.

Lignes 12-14: La méthode get de l'application est utilisée pour ajouter un gestionnaire pour les requêtes GET qui arrivent au chemin racine (/). La fonction de rappel sera appelée à la réception d'une telle demande, et elle utilisera le paramètre «res» (res) pour envoyer la réponse «Hello World!» Au client.

Lignes 16-24: la méthode d'écoute du serveur est utilisée pour se lier au port spécifié et commencer à écouter les demandes entrantes.

Ligne 28: exporter le module pour qu'il puisse être utilisé en externe

Collez le code suivant dans le fichier Accueil> hr_app> index.js

 const webServer = require('./services/web-server.js'); async function startup() { console.log('Starting application'); try { console.log('Initializing web server module'); await webServer.initialize(); } catch (err) { console.error(err); process.exit(1); // Non-zero failure code } } startup(); 

Nous connectons le module de serveur Web, puis il détermine et appelle la fonction de démarrage asynchrone. Étant donné que la fonction d'initialisation du serveur Web renvoie une promesse, vous pouvez l'utiliser avec async / wait et l'encapsuler dans un bloc try-catch. Si la fonction d'initialisation réussit, le serveur Web fonctionnera; sinon, toutes les exceptions seront interceptées et traitées. Tout ce que vous avez à faire maintenant est d'initialiser npm et d'installer Express - vous pouvez alors démarrer l'application. Exécutez les commandes suivantes dans un terminal à partir du répertoire hr_app.

 npm init -y npm install express -s node . 

La commande npm init est utilisée pour créer le fichier package.json, que npm utilise comme fichier manifeste (l'indicateur -y accepte les options par défaut). La commande npm install est utilisée pour installer express (l'indicateur -s ajoute express à la liste de dépendances dans package.json). Npm stocke les modules que vous installez dans le répertoire node_modules. Il crée également un fichier appelé package.lock.json pour fournir une arborescence identique à l'équipe de développement.

Voyez-vous le message que le serveur Web écoute sur localhost: 3000? Félicitations, vous avez créé un serveur express basé sur!

Et le voici, un autre "Hello World". Bien que ce ne soit pas particulièrement amusant, c'est une première étape importante pour votre API.

Lorsque vous êtes prêt, vous pouvez éteindre le serveur en revenant au terminal et en appuyant sur ctrl + c.

Arrêt contrôlé

Pendant l'arrêt en appuyant sur Ctrl + C, vous n'avez aucun contrôle sur la façon dont cela s'est produit. Pour contrôler le processus d'arrêt, vous devez fermer explicitement le serveur Web et quitter le processus Node.js.

Collez le code suivant dans le fichier Home> hr_app> services> web-server.js

 // *** previous code above this line *** function close() { return new Promise((resolve, reject) => { httpServer.close((err) => { if (err) { reject(err); return; } resolve(); }); }); } module.exports.close = close; 

La fonction close renvoie une promesse qui est résolue lorsque le serveur Web se ferme correctement. La méthode httpServer.close arrête l'établissement de nouvelles connexions, mais ne force pas à fermer les connexions déjà ouvertes. Selon le nombre de connexions ouvertes et ce qu'elles font, vous devrez peut-être attendre un peu jusqu'à ce que le rappel fonctionne. Bien que vous ne le fassiez pas dans ce module, vous pouvez utiliser du code personnalisé ou des modules npm tels que http-shutdown pour forcer les connexions ouvertes à se fermer.

Collez le code suivant dans le fichier Accueil> hr_app> index.js

 // *** previous code above this line *** async function shutdown(e) { let err = e; console.log('Shutting down'); try { console.log('Closing web server module'); await webServer.close(); } catch (e) { console.log('Encountered error', e); err = err || e; } console.log('Exiting process'); if (err) { process.exit(1); // Non-zero failure code } else { process.exit(0); } } process.on('SIGTERM', () => { console.log('Received SIGTERM'); shutdown(); }); process.on('SIGINT', () => { console.log('Received SIGINT'); shutdown(); }); process.on('uncaughtException', err => { console.log('Uncaught exception'); console.error(err); shutdown(err); }); 

Les événements SIGINT et SIGTERM se rapportent à des signaux qui peuvent être envoyés à un processus pour l'arrêter, par exemple lorsque vous appuyez sur ctrl + c. Un événement uncaughtException se produit lorsqu'une erreur JavaScript est levée, mais non interceptée et gérée à l'aide de l'instruction try-catch. Essayez de redémarrer et de fermer l'application. Vous découvrirez que tout fonctionne correctement lorsque vous voyez des messages «arrêt» dans le terminal.

Inscription sur le serveur

Il y a encore une chose qui complète notre module de serveur Web: la journalisation HTTP. Il existe différents modules que vous pouvez utiliser pour ce type de connexion, mais morgan est l'un des plus simples. Installons Morgan à l'aide de npm.

 npm install morgan -s 

Ajoutez ensuite la ligne suivante à services / web-server.js sous la ligne qui nécessite express (ligne 2):

 const morgan = require('morgan'); 

Vous pouvez maintenant activer la fonction morgan en tant que middleware à travers lequel toutes les demandes seront traitées en utilisant app.use. Ajoutez cette ligne avant d'appeler app.get, qui affiche le message «Bonjour tout le monde».

 // Combines logging info from request and response app.use(morgan('combined')); // *** app.get call below this line *** 

Notez que app.use crée un pipeline de fonctions middleware qui peuvent interagir avec les requêtes et réponses HTTP. Les fonctions middleware seront exécutées dans l'ordre dans lequel elles sont activées. Redémarrez l'application et installez le terminal pour que vous puissiez le voir et le navigateur en même temps. Chaque fois que vous rechargez la page, vous devriez voir apparaître une nouvelle entrée de journal dans le terminal. Par défaut, morgan transmet les informations de journal à STDOUT (qui s'affiche dans le terminal).

L'article suivant couvrira les bases de l'utilisation des bases de données, y compris les pools de connexions, qui vous aideront à comprendre et à créer l'API REST pour Node.js.