Ako vytvoriť Node.js RESTful API pomocou Express.js na Ubuntu 16.04 LTS

V tomto návode sa naučíte, ako nastaviť kompletné RESTful API, ktoré bude obsluhovať HTTP požiadavky pomocou Node.js a Express pri spätnom proxy serveri s NGINX na Ubuntu 16.04 LTS. Budeme využívať aplikáciu s názvom Postman, veľmi známy nástroj na vývoj API, na testovanie nášho API a uistenie sa, že je plne funkčné a správne funguje. Node.js je rýchly multiplatformový rámec JavaScript založený na motore Chrome V8. Používa sa v desktopových aj serverových aplikáciách a je známy svojou jednovláknovou slučkou udalostí. Node.js budeme používať ako backend pre naše RESTful API, ktoré je súčasťou Express.js, nášho rámca webových aplikácií vytvorených pre Node.js. Express.js je vydaný ako bezplatný a otvorený softvér. Express je na strane servera, je napísaný v jazyku JavaScript a je navrhnutý na vytváranie rozhraní API, vďaka čomu je ideálny pre náš projekt. Na druhej strane, Postman je veľmi výkonný HTTP klient s ohľadom na vývoj API. Obsahuje všetky nástroje, ktoré by ste mohli chcieť pre vývoj API.

Inštalácia Postmana

Najprv chcete prejsť na webovú stránku Postmana a stiahnuť a nainštalovať Postman pre váš hlavný počítač (nie váš server). Všetky pokyny na inštaláciu budú na ich webovej stránke.

Inštalácia Node.js

Na začiatok budeme musieť najskôr nainštalovať Node.js, aby sme mohli začať s vývojom nášho API. Stiahneme a nainštalujeme Node.js z oficiálnej webovej stránky.

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

Okrem toho budete chcieť získať potrebné nástroje na zostavovanie, ktoré vám pomôžu pri zostavovaní modulov.

sudo apt-get install build-essential

V tomto návode budeme používať LTS verziu Node.js, čo je verzia 8.9.3.

Inicializuje sa náš projekt Node.js

Budeme musieť inicializovať nový projekt Node.js, ktorý bude obsahovať aplikáciu. Ak to chcete urobiť, vytvorte nový adresár.

 mkdir expressapi 

Prejdite do nového adresára. Keď ste vo vnútri, spustite npm inita vyplňte všetky požadované výzvy. Poznamenajte si „vstupný bod“ vašej aplikácie: tento súbor vytvoríte neskôr. Po dokončení uvidíte package.jsonsúbor v aktuálnom adresári. Funguje ako popis nášho projektu a uvádza všetky závislosti potrebné na fungovanie.

Nastavenie Express.js

Teraz nakonfigurujeme Express.js a jeho závislosti.

npm install express

Spustí sa proces inštalácie. Dokončenie sťahovania potrvá niekoľko minút.

Spúšťa sa náš hlavný súbor

Ďalej vytvoríme náš hlavný štartovací súbor pre naše API. Tu použijete „vstupný bod“, ktorý ste videli v package.jsonsúbore. V záujme tohto tutoriálu použijem predvolenú schému pomenovania, index.js.

touch index.js

Potom ho otvorte v textovom editore nano.

nano index.js

V našom hlavnom súbore chceme najprv zavolať všetky naše hlavné balíky a zaregistrovať naše trasy.

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);

V podstate to, čo tu robíme, je inicializácia našej aplikácie a nastavenie základného smerovača pre naše API. Všimnite si, že sme nastavili port našej aplikácie na 8080. Toto číslo budeme potrebovať pri konfigurácii nášho RESTful API. Teraz sme pripravení začať testovať naše API.

Testujeme naše API s Postmanom

V adresári projektu spustite nasledovné.

node <filename>.js

Toto spustí API, kde <filename>je štartovací súbor, ktorý ste zadali v package.jsonsúbore. Potom otvorte Postman na vašom PC/Mac a kliknite na tlačidlo „ New“ v pravom hornom rohu a potom kliknite na „ Request“. Keď tam je, mali by ste vidieť pruh s nápisom „ GET“ vedľa neho. Tu zadáme URL našej požiadavky. Do sekcie s adresou URL žiadosti jednoducho zadajte nasledovné a kliknite na „ Send“.

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

Uvidíte „ 'API is online'“.

API trasy

Na spracovanie trás budeme používať smerovač Express. Ak neviete, čo je router, ide v podstate o to, ako koncové body aplikácie reagujú na požiadavky klientov. Tu sú trasy, ktoré nastavíme ako príklad:

• /api/numbers - Zobrazuje všetky čísla od 1 do 10.

• /api/letters - Zobrazuje všetky písmená z AZ.

Teraz nastavíme našu prvú štruktúru middlewaru trasy, podobne.

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})
});

V tomto príklade sme nastavili situáciu, keď používateľ môže požiadať o súčet čísla + 1 zadaním jeho slovného tvaru pomocou metódy GET. Pomocou router.route()funkcie ukážeme na to, aké číslo chceme ako výsledok poslať späť. Parametre sú pomenované s " :" pred nimi. K týmto parametrom pristupujeme cez req.params.

Tu je príklad s písmenami.

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

Používame rovnakú metódu ako vyššie, ale list posielame späť ako veľké.

Úvod do NGINX

NGINX je známy softvér s otvoreným zdrojovým kódom, ktorý sa používa na poskytovanie webových stránok, reverzné servery proxy, streamovanie a ďalšie. NGINX budeme využívať na reverzné proxy naše API, aby sme ho mohli spustiť na porte 80, pretože Node.js nepovoľuje pripojenia na portoch menších ako 1024 bez prístupu root. To sa môže hodiť pri prepájaní vašej domény so serverom.

Nastavenie NGINX

Ak chcete začať s inštaláciou NGINX, musíte vo svojom termináli spustiť nasledovné a počkať na dokončenie inštalácie.

sudo apt-get install nginx

Ďalej budeme chcieť vytvoriť súbor našej stránky, ktorý NGINX použije na reverzný proxy server našej aplikácie.

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

Vyplňte súbor nasledujúcim spôsobom a potom ho uložte znakom CTRL+ O.

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;
       }
}

Pomocou rovnakého portu, na ktorom sme predtým spustili našu aplikáciu, hovoríme Nginxu, aby presmeroval všetky požiadavky z našej adresy IP na porte 80na naše rozhranie API spustené na porte 8080.

Ďalej povoľte reverzný proxy tak, že symbolicky prepojíte náš novovytvorený súbor do sites-availablepriečinka:

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

Tým sa zabezpečí, že NGINX obráti proxy naše API.

Prvý spustenie s NGINX

Po dokončení konfigurácie NGINX spustíme NGINX a potom spustíme naše API. Najprv reštartujte NGINX.

sudo systemctl restart nginx

Potom sa vráťte späť do adresára API a spustite ho.

node <filename>.js

Aplikácia sa spustí na porte 80. Jednoducho spustite test zhora pomocou Postmana, aby ste sa uistili, že všetko funguje správne.

Udržiavanie nášho API v prevádzke

V produkčnom prostredí sa chcete uistiť, že máte správcu procesov pre vaše aplikácie Node, aby ste zaistili, že zostanú bežať navždy na pozadí. V tomto návode budeme používať správcu procesov s názvom PM2 (Process Manager 2), čo je správca procesov pre aplikácie Node.js, ktorý ich udrží pri živote navždy s minimálnymi prestojmi. PM2 prichádza s mnohými užitočnými nástrojmi na správu, ako je zastavenie, opätovné načítanie, pozastavenie a ďalšie. Ak chcete nainštalovať PM2, zadajte nasledovné a počkajte, kým sa nainštaluje.

sudo npm install pm2 -g

Po nainštalovaní sa stačí uistiť, že ste v adresári projektu, zadajte nasledovné a aplikácia sa spustí.

pm2 start <filename>.js

Správa našej aplikácie pomocou PM2

Ako už bolo spomenuté, PM2 má niekoľko užitočných nástrojov, ktoré môžete použiť na lepšiu správu vašej aplikácie.

• pm2 stop- Ako už názov napovedá, umožňuje vám to zastaviť aktuálne spustenú aplikáciu a ukončiť jej proces. Ak vaša aplikácia prináša neočakávaný výsledok, bude užitočné ju zastaviť.

• pm2 list- Funkcia zoznamu vám umožňuje vidieť všetky aktuálne spustené aplikácie cez PM2, zmapované podľa ich názvov. Ak potrebujete rýchlo skontrolovať dostupnosť vašej aplikácie, mali by ste použiť tento nástroj.

• pm2 restart- Ak vaša aplikácia z nejakého dôvodu zamrzne a chceli by ste ju znova načítať, pm2 reštart urobí práve to. Zabije proces aplikácie a spustí ho znova pod iným procesom.

• pm2 monit- Vstavaný monitorovací nástroj PM2 vám umožňuje zobraziť graf špecifických detailov vašej aplikácie, ako je využitie CPU/RAM, v užívateľsky prívetivom grafe v štýle ncurses. To je užitočné, ak chcete vizuálny obraz o zaťažení vašej aplikácie.

Záverečné poznámky

Teraz sme dokončili našu úlohu vytvoriť RESTful API s využitím Node.js, Express a spätného proxy servera s NGINX. Neváhajte a rozšírte tento návod. S vaším novým API môžete robiť veľa skvelých vecí, ako napríklad pridávať metódy overovania, databázu, lepšie spracovávať trasy a chyby a oveľa, oveľa viac. Ak máte doménu so záznamom „A“ už nastaveným pre vašu IP adresu, budete mať prístup k svojmu API z vašej domény. Ak sa chcete o Express.js dozvedieť viac, navštívte ich webovú stránku http://expressjs.com . Ak sa chcete dozvedieť viac o NGINX a reverznom proxy serveri, navštívte http://nginx.com . Ak si chcete prečítať viac o PM2, navštívte ich stránku http://pm2.keymetrics.io .