Node.js RESTful -sovellusliittymän luominen Express.js:n avulla Ubuntu 16.04 LTS:ssä

Tässä opetusohjelmassa opit määrittämään täydellisen RESTful API:n, joka palvelee HTTP-pyyntöjä Node.js:n ja Expressin avulla samalla, kun se kääntää välityspalvelimen NGINX:n kanssa Ubuntu 16.04 LTS:ssä. Käytämme Postman- nimistä sovellusta, erittäin tunnettu API-kehitystyökalu, jonka avulla voit testata sovellusliittymäämme ja varmistaa, että se on täysin toimiva ja toimii oikein. Node.js on nopea, monialustainen JavaScript-kehys, joka perustuu Chromen V8-moottoriin. Sitä käytetään sekä työpöytä- että palvelinsovelluksissa, ja se on kuuluisa yksisäikeisestä tapahtumasilmukan käsittelystään. Käytämme Node.js:ää taustana RESTful API:lle, joka on mukana Express.js:n kanssa, verkkosovelluskehyksemme, joka on rakennettu Node.js:lle. Express.js julkaistaan ​​ilmaisena ja avoimena ohjelmistona. Express on palvelinpuolen, JavaScriptillä kirjoitettu, ja se on suunniteltu API:iden rakentamiseen, mikä tekee siitä täydellisen projektiimme. Toisaalta Postman on erittäin tehokas HTTP-asiakas, joka pitää mielessä API-kehityksen. Se sisältää kaikki työkalut, joita saatat haluta API-kehitykseen.

Postimiehen asennus

Ensin haluat siirtyä Postmanin verkkosivustolle ja ladata ja asentaa Postman päätietokoneellesi (ei palvelimellesi). Kaikki asennusohjeet ovat heidän verkkosivuillaan.

Node.js:n asentaminen

Aluksi meidän on ensin asennettava Node.js, jotta voimme aloittaa API:n kehittämisen. Lataamme ja asennamme Node.js:n viralliselta verkkosivustolta.

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

Lisäksi haluat myös tarttua tarvittaviin rakennustyökaluihin, joista on apua moduulien kokoamisessa.

sudo apt-get install build-essential

Tässä opetusohjelmassa käytämme Node.js:n LTS-versiota, joka on versio 8.9.3.

Node.js-projektimme alustus

Meidän on alustettava uusi Node.js-projekti, joka sisältää sovelluksen. Voit tehdä tämän luomalla uuden hakemiston.

 mkdir expressapi 

Vaihda uuteen hakemistoon. Kun olet sisällä, suorita npm initja täytä kaikki vaaditut kehotteet. Pidä muistissa sovelluksesi "sisääntulokohta": luot tämän tiedoston myöhemmin. Kun olet valmis, näet package.jsontiedoston nykyisessä hakemistossasi. Se toimii kuvauksena projektistamme ja luettelee kaikki toiminnan edellyttämät riippuvuudet.

Express.js:n määrittäminen

Nyt määritämme Express.js:n ja sen riippuvuudet.

npm install express

Asennusprosessi alkaa. Kestää muutaman minuutin, ennen kuin kaikki on ladattu loppuun.

Aloitamme päätiedostomme

Seuraavaksi luomme pääaloitustiedostomme API:lle. Tässä käytät package.jsontiedostossa näkemääsi "sisääntulopistettä" . Tämän opetusohjelman vuoksi käytän oletusnimeämisjärjestelmää, index.js.

touch index.js

Avaa se sitten nanotekstieditorissa.

nano index.js

Päätiedostossamme haluamme ensin kutsua kaikki pääpakettimme ja rekisteröidä reitit.

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

Periaatteessa se, mitä teemme täällä, on sovelluksemme alustaminen ja perusreitittimen määrittäminen API:lle. Huomaa, että asetimme sovelluksemme portiksi 8080. Tarvitsemme tätä numeroa, kun määritämme RESTful API:n. Nyt olemme valmiita menemään eteenpäin ja testaamaan API:tamme.

Testaamme sovellusliittymäämme Postmanin kanssa

Suorita projektihakemistossa seuraava.

node <filename>.js

Tämä käynnistää API:n, jossa <filename>on tiedostossa määrittämäsi aloitustiedosto package.json. Avaa sitten Postman PC-/Mac-tietokoneellasi ja napsauta " New" -painiketta oikeassa yläkulmassa ja napsauta sitten " Request". Kun siellä, sinun pitäisi nähdä palkki, jonka GETvieressä lukee " ". Kirjoita tähän pyyntömme URL-osoite. Kirjoita vain seuraavat tiedot pyynnön URL-osioon ja napsauta " Send".

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

Näet " 'API is online'".

API-reitit

Reittien käsittelyyn käytämme Express-reititintä. Jos et tiedä, mikä reititin on, kyse on lähinnä siitä, kuinka sovelluksen päätepisteet vastaavat asiakkaan pyyntöihin. Tässä ovat reitit, joita määritämme esimerkkinä:

• /api/numbers - Näyttää kaikki numerot 1-10.

• /api/letters - Näyttää kaikki kirjaimet AZ:sta.

Nyt perustamme ensimmäisen reitin väliohjelmistorakenteen, kuten niin.

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

Tässä esimerkissä luomme tilanteen, jossa käyttäjä voi pyytää luvun + 1 summaa antamalla sen sanamuodon GET-menetelmällä. Käytämme router.route()funktiota osoittamaan, minkä numeron haluamme lähettää takaisin tuloksena. Parametrit on nimetty " :" -merkillä niiden edessä. Näihin parametreihin pääsee käsiksi req.params.

Tässä on esimerkki kirjaimista.

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

Käytämme samaa menetelmää kuin yllä, mutta lähetämme kirjeen takaisin isolla kirjoitettuna.

NGINX:n esittely

NGINX on tunnettu avoimen lähdekoodin ohjelmisto, jota käytetään verkkopalveluun, käänteisiin välityspalvelimiin, suoratoistoon ja muuhun. Käytämme NGINX:ää kääntämään API-välityspalvelinta, jotta voimme käyttää sitä portissa 80, koska Node.js ei salli yhteyksiä alle 1024 portteihin ilman pääkäyttäjän oikeuksia. Tästä voi olla hyötyä, kun liität verkkotunnuksesi palvelimeesi.

Asetetaan NGINX

NGINX:n asennuksen aloittamiseksi sinun on suoritettava seuraavat komennot päätteessäsi ja odotettava asennuksen valmistumista.

sudo apt-get install nginx

Seuraavaksi haluamme luoda sivustotiedostomme, jota NGINX käyttää kääntämään sovelluksemme välityspalvelinta.

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

Täytä tiedosto seuraavasti ja tallenna se sitten 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;
       }
}

Käyttämällä samaa porttia, jossa suoritimme sovelluksemme aiemmin, käskemme Nginxiä ohjaamaan kaikki pyynnöt portin IP-osoitteestamme portissa 80toimivaan API:han 8080.

Ota seuraavaksi käänteinen välityspalvelin käyttöön yhdistämällä äskettäin luotu tiedostomme sites-availablekansioon:

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

Tämä varmistaa, että NGINX kääntää sovellusliittymämme välityspalvelimen.

Ensimmäinen ajo NGINX:llä

Kun olemme saaneet valmiiksi NGINX-määrityksen, käynnistämme NGINX:n ja sitten API:n. Käynnistä ensin NGINX uudelleen.

sudo systemctl restart nginx

Vaihda sitten takaisin API-hakemistoosi ja käynnistä se.

node <filename>.js

Sovellus toimii portissa 80. Suorita testi ylhäältä Postmanilla varmistaaksesi, että kaikki toimii oikein.

API:n pitäminen käynnissä

Tuotantoympäristössä haluat varmistaa, että sinulla on prosessinhallinta Node-sovelluksille, jotta ne pysyvät käynnissä ikuisesti taustalla. Tässä opetusohjelmassa käytämme prosessinhallintaa nimeltä PM2 (Process Manager 2), joka on Node.js-sovellusten prosessinhallinta, joka pitää ne hengissä ikuisesti minimaalisella seisokkiajalla. PM2:ssa on monia hyödyllisiä hallintatyökaluja, kuten pysäytys, uudelleenlataus, tauko ja paljon muuta. Asenna PM2 kirjoittamalla seuraava ja odota, että se asentuu.

sudo npm install pm2 -g

Kun se on asennettu, sinun tarvitsee vain varmistaa, että olet projektihakemistossa, kirjoittaa seuraava ja sovellus käynnistyy.

pm2 start <filename>.js

Sovelluksemme hallinta PM2:lla

Kuten aiemmin mainittiin, PM2:ssa on hyödyllisiä työkaluja, joiden avulla voit hallita sovellustasi paremmin.

• pm2 stop- Kuten nimestä voi päätellä, tämän avulla voit pysäyttää käynnissä olevan sovelluksen ja lopettaa sen prosessin. Jos sovelluksesi tuottaa odottamattoman tuloksen, sen pysäyttäminen on hyödyllistä.

• pm2 list- Listatoiminnon avulla voit nähdä kaikki käynnissä olevat sovellukset PM2:n kautta niiden nimien mukaan. Jos sinun on tarkistettava nopeasti sovelluksesi käyttöaika, sinun tulee käyttää tätä työkalua.

• pm2 restart- Jos sovelluksesi jumiutuu jostain syystä ja haluat ladata sen uudelleen, pm2 restart tekee juuri niin. Se lopettaa hakuprosessin ja aloittaa sen uudelleen eri prosessissa.

• pm2 monit- PM2:n sisäänrakennetun näyttötyökalun avulla voit tarkastella kaaviota sovelluksesi erityisistä yksityiskohdista, kuten CPU/RAM-käytöstä, käyttäjäystävällisessä ncurses-tyylisessä kaaviossa. Tämä on hyödyllistä, jos haluat visuaalisen kuvan sovelluksesi latauksesta.

Loppuhuomautukset

Olemme nyt saaneet päätökseen tehtävämme luoda RESTful API, jossa käytetään Node.js:ää, Expressiä ja käänteinen välityspalvelin NGINX:n kanssa. Voit vapaasti laajentaa tätä opetusohjelmaa. Voit tehdä monia hienoja asioita uudella API:llasi, kuten lisätä todennusmenetelmiä, tietokantaa, parantaa reitin ja virheiden käsittelyä ja paljon muuta. Jos sinulla on verkkotunnus, jossa A-tietue on jo määritetty IP-osoitteellesi, voit käyttää API-sovellusliittymääsi verkkotunnuksestasi. Jos haluat lisätietoja Express.js:stä, käy heidän verkkosivustollaan osoitteessa http://expressjs.com . Lisätietoja NGINX:stä ja käänteisestä välityspalvelimesta on osoitteessa http://nginx.com . Lue lisää PM2:sta vierailemalla heidän sivullaan osoitteessa http://pm2.keymetrics.io .