Hur man skapar ett Node.js RESTful API med Express.js på Ubuntu 16.04 LTS

I den här självstudien kommer du att lära dig hur du ställer in ett komplett RESTful API, som kommer att betjäna HTTP-förfrågningar med Node.js och Express medan du använder omvänd proxy med NGINX, på Ubuntu 16.04 LTS. Vi kommer att använda en applikation som heter Postman, ett mycket välkänt API-utvecklingsverktyg, för att testa vårt API och se till att det är fullt fungerande och fungerar korrekt. Node.js är ett snabbt JavaScript-ramverk för flera plattformar baserat på Chromes V8-motor. Den används i både skrivbords- och serverapplikationer och är känd för sin entrådade hantering av händelseslingor. Vi kommer att använda Node.js som backend för vårt RESTful API, tillsammans med Express.js, vårt ramverk för webbapplikationer byggt för Node.js. Express.js släpps som gratis och öppen programvara. Express är server-side, skriven i JavaScript, och är designad för att bygga API:er, vilket gör det perfekt för vårt projekt. Å andra sidan är Postman en mycket kraftfull HTTP-klient, med API-utveckling i åtanke. Den innehåller alla verktyg du kan tänkas vilja ha för API-utveckling.

Installerar Postman

Först vill du gå över till Postmans webbplats och ladda ner och installera Postman för din huvuddator (inte din server). Alla installationsinstruktioner kommer att finnas på deras hemsida.

Installerar Node.js

För att börja måste vi först installera Node.js så att vi kan börja utveckla vårt API. Vi kommer att ladda ner och installera Node.js från den officiella webbplatsen.

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

Dessutom kommer du också att vilja ta tag i de nödvändiga byggverktygen, som kommer att vara till hjälp vid kompilering av moduler.

sudo apt-get install build-essential

För den här handledningen kommer vi att använda LTS-versionen av Node.js, som är version 8.9.3.

Initierar vårt Node.js-projekt

Vi kommer att behöva initiera ett nytt Node.js-projekt, som kommer att innehålla en applikation. För att göra det, skapa en ny katalog.

 mkdir expressapi 

Byt till den nya katalogen. Väl inne, kör npm initoch slutför alla nödvändiga uppmaningar. Notera "ingångspunkten" för din ansökan: du kommer att skapa den här filen senare. När du är klar kommer du att se en package.jsonfil i din nuvarande katalog. Den fungerar som en beskrivning av vårt projekt och listar alla beroenden som behövs för att fungera.

Konfigurera Express.js

Nu kommer vi att konfigurera Express.js och dess beroenden.

npm install express

Installationsprocessen börjar. Det tar några minuter för allt att laddas ner.

Startar vår huvudfil

Därefter kommer vi att skapa vår huvudsakliga startfil för vårt API. Här kommer du att använda "ingångspunkten" som du såg i package.jsonfilen. För den här handledningens skull kommer jag att använda standardnamnschemat, index.js.

touch index.js

Öppna den sedan i nanotextredigeraren.

nano index.js

I vår huvudfil vill vi först anropa alla våra huvudpaket och registrera våra rutter.

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

Vad vi gör här är att initialisera vår app och ställa in en grundläggande router för vårt API. Observera att vi ställer in vår applikations port till 8080. Vi kommer att behöva detta nummer när vi konfigurerar vårt RESTful API. Nu är vi redo att gå vidare och testa vårt API.

Testar vårt API med Postman

Kör följande i projektkatalogen.

node <filename>.js

Detta kommer att starta API, där <filename>är startfilen du angav i package.jsonfilen. Öppna sedan Postman på din PC/Mac och klicka på Newknappen " " i det övre högra hörnet och klicka sedan på " Request". När du är där bör du se en stapel som säger " GET" bredvid den. Här kommer vi att ange vår webbadress för begäran. Skriv bara in följande i avsnittet URL för begäran och klicka på " Send".

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

Du kommer att se " 'API is online'".

API-rutter

För att hantera rutter kommer vi att använda Express-routern. Om du inte vet vad en router är, är det i huvudsak hur applikationsändpunkter svarar på klientförfrågningar. Här är de rutter vi kommer att sätta upp som exempel:

• /api/numbers - Visar alla nummer från 1-10.

• /api/letters - Visar alla bokstäver från A-Ö.

Nu kommer vi att sätta upp vår första rutt-mellanprogramstruktur, som så.

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

I det här exemplet ställer vi upp en situation där en användare kan begära summan av ett tal + 1 genom att ange ordformen för det, med hjälp av GET-metoden. Vi använder router.route()funktionen för att peka på vilket nummer vi vill skicka tillbaka som ett resultat. Parametrar namnges med ett " :" framför dem. Vi kommer åt dessa parametrar via req.params.

Här är ett exempel med bokstäver.

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

Vi använder samma metod som ovan, men vi skickar tillbaka brevet med versaler.

Introduktion till NGINX

NGINX är en välkänd programvara med öppen källkod som används för webbservering, omvända proxyservrar, streaming och mer. Vi kommer att använda NGINX för att omvända proxy för vårt API, för att tillåta oss att köra det på port 80, eftersom Node.js inte tillåter anslutningar på portar mindre än 1024 utan root-åtkomst. Detta kan vara praktiskt när du länkar din domän till din server.

Konfigurera NGINX

För att börja installera NGINX måste du köra följande i din terminal och vänta på att installationen är klar.

sudo apt-get install nginx

Därefter vill vi skapa vår webbplatsfil som NGINX kommer att använda för att vända proxy vår app.

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

Fyll filen med följande, sedan CTRL+ för Oatt spara den.

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

Genom att använda samma port som vi körde vår applikation på tidigare, säger vi till Nginx att omdirigera alla förfrågningar från vår IP-adress på port 80till vårt API som körs på port 8080.

Aktivera sedan omvänd proxy genom att symlinka vår nyskapade fil till sites-availablemappen:

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

Detta kommer att säkerställa att NGINX kommer att omvända proxy vår API.

Kör först med NGINX

När vi har avslutat vår NGINX-konfiguration kommer vi att starta NGINX och sedan starta vårt API. Starta först om NGINX.

sudo systemctl restart nginx

Byt sedan tillbaka till din API-katalog och starta den.

node <filename>.js

Applikationen kommer att köras på port 80. Kör helt enkelt testet ovanifrån med Postman för att säkerställa att allt fungerar korrekt.

Håller vårt API igång

I en produktionsmiljö vill du se till att du har en processhanterare för dina Node-applikationer, för att säkerställa att de körs för alltid i bakgrunden. I den här handledningen kommer vi att använda en processhanterare som heter PM2 (Process Manager 2), som är en processhanterare för Node.js-applikationer som kommer att hålla dem vid liv för alltid med minimal stilleståndstid. PM2 kommer med många användbara hanteringsverktyg, som att stoppa, ladda om, pausa och mer. För att installera PM2, skriv följande och vänta på att den ska installeras.

sudo npm install pm2 -g

När det väl är installerat är allt du behöver göra att se till att du är i projektkatalogen, skriv följande, så startas programmet.

pm2 start <filename>.js

Hantera vår applikation med PM2

Som nämnts tidigare har PM2 några användbara verktyg som du kan använda för att bättre hantera din applikation.

• pm2 stop- Som namnet antyder låter detta dig stoppa den applikation som körs för närvarande och avbryta dess process. Om din applikation ger ett oväntat resultat kommer det att vara praktiskt att stoppa den.

• pm2 list- Listfunktionen låter dig se alla applikationer som körs för närvarande via PM2, mappade med deras namn. Om du snabbt behöver kontrollera din applikations drifttid bör du använda det här verktyget.

• pm2 restart- Om din applikation fryser av någon anledning och du vill ladda om den, gör pm2 restart just det. Det kommer att döda ansökningsprocessen och starta den igen under en annan process.

• pm2 monit- PM2:s inbyggda monitorverktyg låter dig se en graf över din applikations specifika detaljer, såsom CPU/RAM-användning, i en användarvänlig graf i ncurses-stil. Detta är användbart om du vill ha en visuell bild av din applikations belastning.

Slutliga kommentarer

Vi har nu slutfört vår uppgift att skapa ett RESTful API, använda Node.js, Express och omvänd proxyservering med NGINX. Utvidga gärna denna handledning. Du kan göra många fantastiska saker med ditt nya API, som att lägga till autentiseringsmetoder, en databas, bättre väg- och felhantering och mycket, mycket mer. Om du har en domän, med en "A"-post redan inställd på din IP-adress, kommer du att kunna komma åt ditt API från din domän. Om du vill lära dig mer om Express.js, besök deras webbplats på http://expressjs.com . För att lära dig mer om NGINX och omvänd proxy, besök http://nginx.com . För att läsa mer om PM2, besök deras sida på http://pm2.keymetrics.io .