Kako ustvariti Node.js RESTful API z uporabo Express.js v Ubuntu 16.04 LTS

V tej vadnici se boste naučili, kako nastaviti popoln API RESTful, ki bo služil zahtevam HTTP z uporabo Node.js in Express, medtem ko bo obratno proxy z NGINX, v Ubuntu 16.04 LTS. Uporabili bomo aplikacijo Postman, zelo dobro znano orodje za razvoj API-ja, s katerim lahko preizkusite naš API in se prepričate, da je popolnoma funkcionalen in pravilno deluje. Node.js je hiter, večplatformski okvir JavaScript, ki temelji na Chromovem motorju V8. Uporablja se v namiznih in strežniških aplikacijah in je znan po enonitnem ravnanju z zanko dogodkov. Node.js bomo uporabljali kot backend za naš RESTful API, ki je v paketu z Express.js, našim ogrodjem spletne aplikacije, zgrajenim za Node.js. Express.js je izdana kot brezplačna in odprta programska oprema. Express je na strani strežnika, napisan v JavaScriptu in je zasnovan za gradnjo API-jev, zaradi česar je popoln za naš projekt. Po drugi strani je Postman zelo zmogljiv odjemalec HTTP, ki ima v mislih razvoj API-ja. Vsebuje vsa orodja, ki bi jih morda želeli za razvoj API-ja.

Namestitev Poštarja

Najprej se želite odpraviti na spletno mesto Postmana ter prenesti in namestiti Postman za svoj glavni računalnik (ne vaš strežnik). Vsa navodila za namestitev bodo na njihovi spletni strani.

Namestitev Node.js

Za začetek bomo morali najprej namestiti Node.js, da bomo lahko začeli razvijati naš API. Node.js bomo prenesli in namestili z uradne spletne strani.

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

Poleg tega boste želeli zgrabiti tudi potrebna orodja za gradnjo, ki vam bodo v pomoč pri prevajanju modulov.

sudo apt-get install build-essential

Za to vadnico bomo uporabljali LTS različico Node.js, ki je različica 8.9.3.

Inicializacija našega projekta Node.js

Inicializirati bomo morali nov projekt Node.js, ki bo vseboval aplikacijo. Če želite to narediti, ustvarite nov imenik.

 mkdir expressapi 

Preklopite v nov imenik. Ko ste notri, zaženite npm initin izpolnite vse zahtevane pozive. Bodite pozorni na "vstopno točko" vaše aplikacije: to datoteko boste ustvarili pozneje. Ko končate, boste videli package.jsondatoteko v trenutnem imeniku. Deluje kot opis našega projekta in navaja vse odvisnosti, potrebne za delovanje.

Nastavitev Express.js

Zdaj bomo konfigurirali Express.js in njegove odvisnosti.

npm install express

Postopek namestitve se bo začel. Prenos vsega bo trajal nekaj minut.

Zagon naše glavne datoteke

Nato bomo ustvarili našo glavno začetno datoteko za naš API. Tukaj boste uporabili "vstopno točko", ki ste jo videli v package.jsondatoteki. Zaradi te vadnice bom uporabil privzeto shemo poimenovanja, index.js.

touch index.js

Nato ga odprite v urejevalniku besedil nano.

nano index.js

V naši glavni datoteki želimo najprej poklicati vse naše glavne pakete in registrirati naše poti.

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 bistvu to, kar počnemo tukaj, je inicializacija naše aplikacije in nastavitev osnovnega usmerjevalnika za naš API. Upoštevajte, da smo vrata naše aplikacije nastavili na 8080. To številko bomo potrebovali, ko bomo konfigurirali naš RESTful API. Zdaj smo pripravljeni, da nadaljujemo in testiramo naš API.

Testiranje našega API-ja s Postmanom

V imeniku projekta zaženite naslednje.

node <filename>.js

To bo zagnalo API, kjer <filename>je začetna datoteka, ki ste jo navedli v package.jsondatoteki. Nato odprite Postman na vašem PC/Mac in kliknite gumb " New" v zgornjem desnem kotu, nato kliknite " Request". Ko ste tam, bi morali videti vrstico z napisom " GET" poleg nje. Tukaj bomo vnesli URL naše zahteve. Preprosto vnesite naslednje v razdelek URL zahteve in kliknite » Send«.

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

Videli boste " 'API is online'".

API poti

Za upravljanje poti bomo uporabljali usmerjevalnik Express. Če ne veste, kaj je usmerjevalnik, je v bistvu to, kako se končne točke aplikacije odzivajo na zahteve odjemalca. Tukaj so poti, ki jih bomo postavili kot primer:

• /api/numbers - Prikazuje vse številke od 1-10.

• /api/letters - Prikazuje vse črke od A-ja.

Zdaj bomo postavili našo prvo strukturo vmesne programske opreme poti, tako.

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 tem primeru smo postavili situacijo, v kateri lahko uporabnik zahteva vsoto števila + 1 tako, da poda njegovo besedno obliko z uporabo metode GET. S router.route()funkcijo pokažemo, katero številko želimo kot rezultat poslati nazaj. Parametri so poimenovani z " :" pred njimi. Do teh parametrov(-ov) dostopamo prek req.params.

Tukaj je primer s črkami.

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

Uporabljamo enako metodo kot zgoraj, vendar pismo pošljemo nazaj z veliko začetnico.

Uvod v NGINX

NGINX je dobro znana odprtokodna programska oprema, ki se uporablja za spletno strežbo, povratne proxyje, pretakanje in drugo. Uporabili bomo NGINX za obratno proxy našega API-ja, da bi nam omogočili, da ga zaženemo na vratih 80, ker Node.js ne dovoljuje povezav na vratih manj kot 1024 brez korenskega dostopa. To vam lahko pride prav pri povezovanju vaše domene s strežnikom.

Nastavitev NGINX

Če želite začeti nameščati NGINX, boste morali v terminalu zagnati naslednje in počakati, da se namestitev zaključi.

sudo apt-get install nginx

Nato bomo želeli ustvariti datoteko našega spletnega mesta, ki jo bo NGINX uporabil za povratni proxy naše aplikacije.

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

Zapolnite datoteko z naslednjim, nato CTRL+, Oda jo shranite.

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

Z uporabo istih vrat, na katerih smo zagnali našo aplikacijo prej, sporočamo Nginxu, naj vse zahteve z našega naslova IP na vratih preusmeri 80v naš API, ki teče na vratih 8080.

Nato omogočite povratni proxy tako, da našo novo ustvarjeno datoteko simbolično povežete z sites-availablemapo:

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

To bo zagotovilo, da bo NGINX obrnil proxy našega API-ja.

Prvi zagon z NGINX

Ko končamo konfiguracijo NGINX, bomo zagnali NGINX in nato naš API. Najprej znova zaženite NGINX.

sudo systemctl restart nginx

Nato se vrnite nazaj v imenik API in ga zaženite.

node <filename>.js

Aplikacija se bo zagnala na vratih 80. Preprosto zaženite test od zgoraj s Postman, da se prepričate, da vse deluje pravilno.

Ohranjanje delovanja našega API-ja

V produkcijskem okolju želite zagotoviti, da imate upravljalnika procesov za vaše aplikacije Node, da zagotovite, da bodo večno delovale v ozadju. V tej vadnici bomo uporabljali upravljalnik procesov, imenovan PM2 (Process Manager 2), ki je upravitelj procesov za aplikacije Node.js, ki jih bo ohranjal pri življenju za vedno z minimalnimi izpadi. PM2 ima veliko uporabnih orodij za upravljanje, kot so ustavitev, ponovno nalaganje, premor in drugo. Če želite namestiti PM2, vnesite naslednje in počakajte, da se namesti.

sudo npm install pm2 -g

Ko je nameščen, se morate samo prepričati, da ste v imeniku projekta, vnesite naslednje in aplikacija se bo zagnala.

pm2 start <filename>.js

Upravljanje naše aplikacije s PM2

Kot smo že omenili, ima PM2 nekaj uporabnih orodij, ki jih lahko uporabite za boljše upravljanje svoje aplikacije.

• pm2 stop- Kot že ime pove, vam to omogoča, da ustavite trenutno delujočo aplikacijo in ustavite njen proces. Če vaša aplikacija daje nepričakovan rezultat, bo ustavitev prišla prav.

• pm2 list- Funkcija seznama vam omogoča, da vidite vse trenutno delujoče aplikacije prek PM2, preslikane z njihovimi imeni. Če želite hitro preveriti čas delovanja aplikacije, uporabite to orodje.

• pm2 restart- Če vaša aplikacija iz nekega razloga zamrzne in jo želite znova naložiti, pm2 ponovni zagon naredi prav to. To bo uničilo postopek prijave in ga znova zagnalo pod drugim postopkom.

• pm2 monit- Vgrajeno orodje za spremljanje PM2 vam omogoča ogled grafa specifičnih podrobnosti vaše aplikacije, kot je uporaba CPU/RAM-a, v uporabniku prijaznem grafu v slogu ncurses. To je uporabno, če želite vizualno sliko obremenitve vaše aplikacije.

Končne pripombe

Zdaj smo zaključili našo nalogo ustvarjanja API-ja RESTful z uporabo Node.js, Express in povratnega proxyja z NGINX. Razširite to vadnico. S svojim novim API-jem lahko naredite veliko odličnih stvari, na primer dodate metode preverjanja pristnosti, bazo podatkov, boljšo pot in ravnanje z napakami in še veliko, veliko več. Če imate domeno z zapisom "A", ki je že nastavljen na vaš naslov IP, boste lahko dostopali do svojega API-ja iz vaše domene. Če želite izvedeti več o Express.js, obiščite njihovo spletno mesto na naslovu http://expressjs.com . Če želite izvedeti več o NGINX in povratnem proxyju, obiščite http://nginx.com . Če želite prebrati več o PM2, obiščite njihovo stran na naslovu http://pm2.keymetrics.io .