Kako stvoriti Node.js RESTful API koristeći Express.js na Ubuntu 16.04 LTS

U ovom vodiču naučit ćete kako postaviti potpuni RESTful API, koji će služiti HTTP zahtjeve koristeći Node.js i Express dok ga obrnuti proxy putem NGINX-a, na Ubuntu 16.04 LTS. Koristit ćemo aplikaciju pod nazivom Postman, vrlo poznati razvojni alat API-ja, za testiranje našeg API-ja i uvjeravanje da je potpuno funkcionalan i da radi ispravno. Node.js je brzi, višeplatformski JavaScript okvir koji se temelji na Chromeovom V8 motoru. Koristi se u desktop i poslužiteljskim aplikacijama i poznat je po rukovanju petlji s jednim niti. Koristit ćemo Node.js kao pozadinu za naš RESTful API, u paketu s Express.js, našim okvirom web aplikacije izgrađenom za Node.js. Express.js je objavljen kao besplatni i otvoreni softver. Express je na strani poslužitelja, napisan u JavaScriptu i dizajniran je za izgradnju API-ja, što ga čini savršenim za naš projekt. S druge strane, Postman je vrlo moćan HTTP klijent, s razvojem API-ja na umu. Sadrži sve alate koje biste mogli poželjeti za razvoj API-ja.

Instaliranje Poštara

Prvo, želite prijeći na Postmanovu web stranicu , te preuzeti i instalirati Postman za svoje glavno računalo (ne vaš poslužitelj). Sve upute za instalaciju bit će na njihovoj web stranici.

Instaliranje Node.js

Za početak, prvo ćemo morati instalirati Node.js kako bismo mogli početi razvijati naš API. Node.js ćemo preuzeti i instalirati sa službene web stranice.

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

Osim toga, također ćete htjeti zgrabiti potrebne alate za izgradnju, koji će vam biti od pomoći pri sastavljanju modula.

sudo apt-get install build-essential

Za ovaj vodič koristit ćemo LTS verziju Node.js, a to je verzija 8.9.3.

Inicijalizacija našeg Node.js projekta

Morat ćemo inicijalizirati novi Node.js projekt, koji će sadržavati aplikaciju. Da biste to učinili, stvorite novi direktorij.

 mkdir expressapi 

Promijenite u novi imenik. Kada uđete, pokrenite npm initi ispunite sve potrebne upute. Zabilježite "ulaznu točku" vaše aplikacije: ovu ćete datoteku izraditi kasnije. Nakon što završite, vidjet ćete package.jsondatoteku u vašem trenutnom direktoriju. Djeluje kao opis našeg projekta i navodi sve ovisnosti potrebne za funkcioniranje.

Postavljanje Express.js

Sada ćemo konfigurirati Express.js i njegove ovisnosti.

npm install express

Započet će proces instalacije. Trebat će nekoliko minuta da se sve završi preuzimanje.

Pokrećemo našu glavnu datoteku

Zatim ćemo kreirati našu glavnu početnu datoteku za naš API. Ovdje ćete koristiti "ulaznu točku" koju ste vidjeli u package.jsondatoteci. Radi ovog vodiča, koristit ću zadanu shemu imenovanja, index.js.

touch index.js

Zatim ga otvorite u uređivaču teksta nano.

nano index.js

U našoj glavnoj datoteci želimo prvo pozvati sve naše glavne pakete i registrirati naše rute.

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

U osnovi ono što ovdje radimo je inicijalizacija naše aplikacije i postavljanje osnovnog usmjerivača za naš API. Imajte na umu da smo port naše aplikacije postavili na 8080. Ovaj broj će nam trebati kada konfiguriramo naš RESTful API. Sada smo spremni krenuti naprijed i testirati naš API.

Testiranje našeg API-ja s Postmanom

U direktoriju projekta pokrenite sljedeće.

node <filename>.js

Ovo će pokrenuti API, gdje <filename>je početna datoteka koju ste naveli u package.jsondatoteci. Zatim otvorite Postman na svom PC/Mac računalu i kliknite Newgumb " " u gornjem desnom kutu, a zatim kliknite " Request". Kad ste tamo, trebali biste vidjeti traku s natpisom " GET" pored nje. Ovdje ćemo unijeti URL našeg zahtjeva. Jednostavno unesite sljedeće u odjeljak URL zahtjeva i kliknite " Send".

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

Vidjet ćete " 'API is online'".

API rute

Za rukovanje rutama koristit ćemo Express usmjerivač. Ako ne znate što je usmjerivač, u biti je to kako krajnje točke aplikacije odgovaraju na zahtjeve klijenata. Evo ruta koje ćemo postaviti kao primjer:

• /api/numbers - Prikazuje sve brojeve od 1-10.

• /api/letters - Prikazuje sva slova od AZ.

Sada ćemo postaviti našu prvu međuprogramsku strukturu rute, ovako.

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

U ovom primjeru postavili smo situaciju u kojoj korisnik može zatražiti zbroj broja + 1 navodeći njegov oblik riječi, koristeći metodu GET. Koristimo router.route()funkciju da pokažemo koji broj želimo poslati natrag kao rezultat. Parametri se imenuju s " :" ispred njih. Ovim parametrima pristupamo putem req.params.

Evo primjera sa slovima.

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

Koristimo istu metodu kao gore, ali pismo šaljemo s velikim slovima.

Uvod u NGINX

NGINX je dobro poznati softver otvorenog koda koji se koristi za web posluživanje, obrnuti proxy server, streaming i još mnogo toga. Koristit ćemo NGINX za obrnuti proxy naš API, kako bi nam omogućili da ga pokrenemo na portu 80, jer Node.js ne dopušta veze na portovima manjim od 1024 bez root pristupa. Ovo može biti korisno kada povezujete svoju domenu s poslužiteljem.

Postavljanje NGINX-a

Za početak instaliranja NGINX-a morat ćete pokrenuti sljedeće u svom terminalu i pričekati da se instalacija završi.

sudo apt-get install nginx

Zatim ćemo htjeti stvoriti datoteku naše web stranice koju će NGINX koristiti za obrnuti proxy naše aplikacije.

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

Popunite datoteku sljedećim, a zatim CTRL+ Oda biste je spremili.

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

Koristeći isti port na kojem smo ranije pokrenuli našu aplikaciju, govorimo Nginxu da preusmjeri sve zahtjeve s naše IP adrese na portu 80na naš API koji radi na portu 8080.

Zatim omogućite obrnuti proxy simbolom povezivanja naše novostvorene datoteke s sites-availablemapom:

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

To će osigurati da će NGINX obrnuti proxy naš API.

Prvo pokretanje s NGINX-om

Nakon što završimo našu NGINX konfiguraciju, pokrenut ćemo NGINX, a zatim pokrenuti naš API. Prvo ponovno pokrenite NGINX.

sudo systemctl restart nginx

Zatim se vratite u svoj API direktorij i pokrenite ga.

node <filename>.js

Aplikacija će se pokrenuti na portu 80. Jednostavno pokrenite test odozgo s Postman-om kako biste bili sigurni da sve radi ispravno.

Održavanje rada našeg API-ja

U proizvodnom okruženju, želite biti sigurni da imate upravitelja procesa za svoje Node aplikacije, kako biste osigurali da one ostaju raditi zauvijek u pozadini. U ovom vodiču koristit ćemo upravitelj procesa pod nazivom PM2 (Process Manager 2), koji je upravitelj procesa za Node.js aplikacije koji će ih zauvijek održavati na životu s minimalnim zastojima. PM2 dolazi s mnogim korisnim alatima za upravljanje, kao što su zaustavljanje, ponovno učitavanje, pauziranje i još mnogo toga. Da biste instalirali PM2, upišite sljedeće i pričekajte da se instalira.

sudo npm install pm2 -g

Nakon što se instalira, sve što trebate učiniti je provjeriti jeste li u direktoriju projekta, upisati sljedeće i aplikacija će se pokrenuti.

pm2 start <filename>.js

Upravljanje našom aplikacijom s PM2

Kao što je ranije spomenuto, PM2 ima neke korisne alate koje možete koristiti za bolje upravljanje svojom aplikacijom.

• pm2 stop- Kao što ime sugerira, ovo vam omogućuje da zaustavite trenutno pokrenutu aplikaciju i zaustavite njezin proces. Ako vaša aplikacija daje neočekivani rezultat, zaustavljanje će vam dobro doći.

• pm2 list- Funkcija popisa omogućuje vam da vidite sve trenutno pokrenute aplikacije putem PM2, mapirane prema njihovim nazivima. Ako trebate brzo provjeriti vrijeme rada svoje aplikacije, trebali biste koristiti ovaj alat.

• pm2 restart- Ako se vaša aplikacija iz nekog razloga zamrzne, a želite je ponovno učitati, pm2 restart čini upravo to. To će ubiti proces prijave i pokrenuti ga ponovno, pod drugim procesom.

• pm2 monit- Ugrađeni alat za praćenje PM2 omogućuje vam pregled grafa specifičnih pojedinosti vaše aplikacije, kao što je korištenje CPU/RAM-a, u grafu u stilu ncurses. Ovo je korisno ako želite vizualnu sliku opterećenja vaše aplikacije.

Završne napomene

Sada smo dovršili naš zadatak stvaranja RESTful API-ja, koristeći Node.js, Express, i obrnuto proxy s NGINX-om. Slobodno proširite ovaj vodič. Sa svojim novim API-jem možete učiniti mnogo sjajnih stvari, kao što je dodavanje metoda provjere autentičnosti, baze podataka, bolje rukovanje rutama i pogreškama i još mnogo, puno više. Ako imate domenu, s "A" zapisom koji je već postavljen na vašu IP adresu, tada ćete moći pristupiti svom API-ju sa svoje domene. Ako želite saznati više o Express.js, posjetite njihovu web stranicu na http://expressjs.com . Da biste saznali više o NGINX-u i obrnutom proxy-u, posjetite http://nginx.com . Da biste pročitali više o PM2, posjetite njihovu stranicu na http://pm2.keymetrics.io .