Com crear una API RESTful Node.js utilitzant Express.js a Ubuntu 16.04 LTS

En aquest tutorial, aprendràs a configurar una API RESTful completa, que servirà les sol·licituds HTTP mitjançant Node.js i Express mentre l'enviaràs amb NGINX, a Ubuntu 16.04 LTS. Utilitzarem una aplicació anomenada Postman, una eina de desenvolupament d'API molt coneguda, per provar la nostra API i assegurar-nos que funciona completament i funciona correctament. Node.js és un marc de JavaScript ràpid i multiplataforma basat en el motor V8 de Chrome. S'utilitza tant en aplicacions d'escriptori com de servidor i és famós pel seu maneig de bucles d'esdeveniments d'un sol fil. Utilitzarem Node.js com a backend per a la nostra API RESTful, inclosa amb Express.js, el nostre marc d'aplicacions web creat per Node.js. Express.js es publica com a programari lliure i obert. Express és del costat del servidor, escrit en JavaScript i està dissenyat per crear API, cosa que el fa perfecte per al nostre projecte. D'altra banda, Postman és un client HTTP molt potent, tenint en compte el desenvolupament d'API. Inclou totes les eines que podríeu desitjar per al desenvolupament d'API.

Instal·lació de Postman

En primer lloc, voleu dirigir-vos al lloc web de Postman i descarregar i instal·lar Postman al vostre ordinador principal (no al vostre servidor). Totes les instruccions d'instal·lació estaran al seu lloc web.

Instal·lant Node.js

Per començar, primer haurem d'instal·lar Node.js perquè puguem començar a desenvolupar la nostra API. Anem a baixar i instal·lar Node.js des del lloc web oficial.

 curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
 sudo apt-get install -y nodejs

A més, també voldreu agafar les eines de creació necessàries, que us seran útils per compilar mòduls.

sudo apt-get install build-essential

Per a aquest tutorial, farem servir la versió LTS de Node.js, que és la versió 8.9.3.

Inicialització del nostre projecte Node.js

Haurem d'inicialitzar un nou projecte Node.js, que contindrà una aplicació. Per fer-ho, creeu un directori nou.

 mkdir expressapi 

Canvia al directori nou. Un cop dins, executeu npm initi completeu totes les indicacions necessàries. Tingueu en compte el "punt d'entrada" de la vostra aplicació: creareu aquest fitxer més tard. Un cop hàgiu acabat, veureu un package.jsonfitxer al vostre directori actual. Actua com a descripció del nostre projecte i enumera totes les dependències necessàries per funcionar.

Configurant Express.js

Ara configurarem Express.js i les seves dependències.

npm install express

S'iniciarà el procés d'instal·lació. Caldrà uns minuts perquè tot s'acabi de descarregar.

Començant el nostre fitxer principal

A continuació, crearem el nostre fitxer d'inici principal per a la nostra API. Aquí és on utilitzareu el "punt d'entrada" que heu vist al package.jsonfitxer. Pel bé d'aquest tutorial, utilitzaré l'esquema de nom predeterminat, index.js.

touch index.js

A continuació, obriu-lo a l'editor de text nano.

nano index.js

Al nostre fitxer principal, primer volem trucar a tots els nostres paquets principals i registrar les nostres rutes.

var express = require('express');        
var app = express();                 
var bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
var port = process.env.PORT || 8080;  
const router = express.Router();
router.get('/', function(req, res) {
    res.json({ message: 'API is Online!' });   
});

app.use('/api', router);
app.listen(port);
console.log('Listening on port ' + port);

Bàsicament, el que estem fent aquí és inicialitzar la nostra aplicació i configurar un encaminador bàsic per a la nostra API. Tingueu en compte que establim el port de la nostra aplicació a 8080. Necessitarem aquest número per quan configurem la nostra API RESTful. Ara estem preparats per seguir endavant i provar la nostra API.

Provant la nostra API amb Postman

Al directori del projecte, executeu el següent.

node <filename>.js

Això iniciarà l'API, on <filename>és el fitxer d'inici que heu especificat al package.jsonfitxer. A continuació, obriu Postman al vostre PC/Mac i feu clic al Newbotó " " de l'extrem superior dret i, a continuació, feu clic a " Request". Quan hi hagi, hauríeu de veure una barra que diu " GET" al costat. Aquí introduirem la nostra URL de sol·licitud. Simplement introduïu el següent a la secció d'URL de sol·licitud i feu clic a " Send".

`http://your-server-ip:3000/api` 

Veureu " 'API is online'".

Rutes API

Per gestionar rutes, utilitzarem l'encaminador Express. Si no sabeu què és un encaminador, és bàsicament com els punts finals de l'aplicació responen a les sol·licituds dels clients. Aquestes són les rutes que establirem com a exemple:

• /api/numbers - Mostra tots els números de l'1 al 10.

• /api/letters - Mostra totes les lletres de l'AZ.

Ara configurarem la nostra primera estructura de middleware de ruta, així.

router.use(function(req, res, next) {
   console.log('We've got something.');
   next() //calls next middleware in the application.
});

router.route('/numbers/:number').get((req, res) => {
     res.json({result: req.params.number + 1})
});

En aquest exemple, configurem una situació en què un usuari pot sol·licitar la suma d'un nombre + 1 proporcionant-ne la forma de paraula, utilitzant el mètode GET. Utilitzem la router.route()funció per assenyalar quin número volem enviar com a resultat. Els paràmetres s'anomenen amb un " :" al davant. Accedim a aquests paràmetres mitjançant req.params.

Aquí teniu un exemple amb lletres.

   router.route('/letters/:letter').get((req, res) => {
     res.json({result: req.params.letter.toUpperCase()})
});

Utilitzem el mateix mètode que l'anterior, però enviem la carta en majúscula.

Introducció a NGINX

NGINX és un programari de codi obert conegut que s'utilitza per al servei web, servidors intermediaris inversos, streaming i molt més. Utilitzarem NGINX per revertir el servidor intermediari de la nostra API, per permetre'ns executar-la al port 80, perquè Node.js no permet connexions en ports inferiors a 1024 sense accés root. Això pot ser útil quan enllaceu el vostre domini al vostre servidor.

Configuració de NGINX

Per començar a instal·lar NGINX, haureu d'executar el següent al vostre terminal i esperar que finalitzi la instal·lació.

sudo apt-get install nginx

A continuació, volem crear el nostre fitxer de lloc que NGINX utilitzarà per revertir el servidor intermediari de la nostra aplicació.

sudo nano /etc/nginx/sites-available-api.js

Omple el fitxer amb el següent i després CTRL+ Oper desar-lo.

server {
          listen 80;
          location / {
                proxy_set_header X-Real-IP 
                $remote_addr;
                proxy_set_header 
                X-Forwarded-For 
                $proxy_add_x_forwarded_for;
                proxy_set_header Host 
                $http_host;
                proxy_set_header 
                X-NginX-Proxy true; proxy_pass 
                http://127.0.0.1:8080/;
                proxy_redirect off;
                proxy_http_version 1.1;
                proxy_set_header Upgrade 
                $http_upgrade;
                proxy_set_header Connection 
                "upgrade";
                proxy_redirect off;
                proxy_set_header 
               X-Forwarded-Proto $scheme;
       }
}

Utilitzant el mateix port on vam executar la nostra aplicació anteriorment, estem dient a Nginx que redirigeixi totes les sol·licituds de la nostra adreça IP al port 80a la nostra API que s'executa al port 8080.

A continuació, activeu el servidor intermediari invers enllaçant simbòlicament el nostre fitxer acabat de crear a la sites-availablecarpeta:

sudo ln -s /etc/nginx/sites-available/api /etc/nginx/sites-available

Això garantirà que NGINX invertirà el servidor intermediari de la nostra API.

Primer execució amb NGINX

Un cop hàgim acabat la nostra configuració de NGINX, iniciarem NGINX i després iniciarem la nostra API. Primer, reinicieu NGINX.

sudo systemctl restart nginx

A continuació, torneu al vostre directori de l'API i inicieu-lo.

node <filename>.js

L'aplicació s'executarà al port 80. Simplement executeu la prova des de dalt amb Postman, per assegurar-vos que tot funciona correctament.

Mantenir en funcionament la nostra API

En un entorn de producció, voleu assegurar-vos que disposeu d'un gestor de processos per a les vostres aplicacions Node, per assegurar-vos que es mantinguin en funcionament per sempre en segon pla. En aquest tutorial, utilitzarem un gestor de processos anomenat PM2 (Gestor de processos 2), que és un gestor de processos per a aplicacions Node.js que els mantindrà vius per sempre amb un temps d'inactivitat mínim. PM2 inclou moltes eines de gestió útils, com ara aturar, tornar a carregar, posar en pausa i molt més. Per instal·lar PM2, escriviu el següent i espereu que s'instal·li.

sudo npm install pm2 -g

Un cop instal·lat, tot el que heu de fer és assegurar-vos que esteu al directori del projecte, escriviu el següent i s'iniciarà l'aplicació.

pm2 start <filename>.js

Gestionant la nostra aplicació amb PM2

Com s'ha esmentat anteriorment, PM2 té algunes eines útils que podeu utilitzar per gestionar millor la vostra aplicació.

• pm2 stop- Com el seu nom indica, això us permet aturar l'aplicació que s'executa actualment i acabar amb el seu procés. Si la vostra aplicació està produint un resultat inesperat, serà útil aturar-la.

• pm2 list- La funció de llista us permet veure totes les aplicacions que s'executen actualment mitjançant PM2, assignades pels seus noms. Si necessiteu comprovar ràpidament el temps d'activitat de la vostra aplicació, hauríeu d'utilitzar aquesta eina.

• pm2 restart- Si la vostra aplicació es bloqueja per algun motiu i voleu tornar-la a carregar, pm2 restart fa exactament això. Matarà el procés de sol·licitud i el tornarà a iniciar, amb un procés diferent.

• pm2 monit- L'eina de monitor integrada de PM2 us permet veure un gràfic dels detalls específics de la vostra aplicació, com ara l'ús de CPU/RAM, en un gràfic d'estil ncurses fàcil d'utilitzar. Això és útil si voleu una imatge visual de la càrrega de la vostra aplicació.

Observacions finals

Ara hem completat la nostra tasca de crear una API RESTful, utilitzant Node.js, Express i fent-ne un servidor intermediari invers amb NGINX. No dubteu a ampliar aquest tutorial. Podeu fer moltes coses fantàstiques amb la vostra nova API, com ara afegir mètodes d'autenticació, una base de dades, una millor gestió de rutes i errors i molt, molt més. Si teniu un domini, amb un registre "A" ja configurat a la vostra adreça IP, podreu accedir a la vostra API des del vostre domini. Si voleu obtenir més informació sobre Express.js, visiteu el seu lloc web a http://expressjs.com . Per obtenir més informació sobre NGINX i el proxy invers, visiteu http://nginx.com . Per obtenir més informació sobre PM2, visiteu la seva pàgina a http://pm2.keymetrics.io .