Sådan opretter du en Node.js RESTful API ved hjælp af Express.js på Ubuntu 16.04 LTS

I denne vejledning lærer du, hvordan du opsætter en komplet RESTful API, som vil betjene HTTP-anmodninger ved hjælp af Node.js og Express, mens du omvendt proxyerer den med NGINX, på Ubuntu 16.04 LTS. Vi vil bruge en applikation kaldet Postmand, et meget velkendt API-udviklingsværktøj, til at teste vores API og sikre, at det er fuldt funktionelt og fungerer korrekt. Node.js er en hurtig JavaScript-ramme på tværs af platforme baseret på Chromes V8-motor. Den bruges i både desktop- og serverapplikationer og er berømt for sin enkelttrådede hændelsesløkkehåndtering. Vi vil bruge Node.js som backend til vores RESTful API, bundtet med Express.js, vores webapplikationsramme bygget til Node.js. Express.js udgives som gratis og åben software. Express er server-side, skrevet i JavaScript, og er designet til at bygge API'er, hvilket gør det perfekt til vores projekt. På den anden side er Postman en meget kraftfuld HTTP-klient med API-udvikling i tankerne. Den indeholder alle de værktøjer, du kunne ønske dig til API-udvikling.

Installation af Postman

Først vil du gå over til Postmans hjemmeside og downloade og installere Postman til din primære pc (ikke din server). Alle installationsvejledninger vil være på deres hjemmeside.

Installerer Node.js

For at begynde skal vi først installere Node.js, så vi kan begynde at udvikle vores API. Vi vil downloade og installere Node.js fra den officielle hjemmeside.

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

Derudover vil du også gerne have fat i de nødvendige byggeværktøjer, som vil være nyttige ved kompilering af moduler.

sudo apt-get install build-essential

Til denne tutorial vil vi bruge LTS-versionen af ​​Node.js, som er version 8.9.3.

Initialiserer vores Node.js-projekt

Vi bliver nødt til at initialisere et nyt Node.js-projekt, som vil indeholde en applikation. For at gøre det skal du oprette en ny mappe.

 mkdir expressapi 

Skift til den nye mappe. Når du er inde, skal du køre npm initog udfylde alle de nødvendige prompter. Vær opmærksom på "indgangspunktet" for din ansøgning: du vil oprette denne fil senere. Når du er færdig, vil du se en package.jsonfil i din nuværende mappe. Det fungerer som en beskrivelse af vores projekt og viser alle de afhængigheder, der er nødvendige for at fungere.

Opsætning af Express.js

Nu vil vi konfigurere Express.js og dets afhængigheder.

npm install express

Installationsprocessen begynder. Det vil tage et par minutter, før alt er downloadet.

Starter vores hovedfil

Dernæst vil vi oprette vores primære startfil til vores API. Her vil du bruge "indgangspunktet", du så i package.jsonfilen. Af hensyn til denne tutorial vil jeg bruge standardnavneskemaet, index.js.

touch index.js

Åbn den derefter i nano-teksteditoren.

nano index.js

I vores hovedfil vil vi først ringe til alle vores hovedpakker og registrere vores ruter.

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

Grundlæggende er det, vi gør her, at initialisere vores app og opsætte en grundlæggende router til vores API. Bemærk, at vi indstiller vores applikations port til 8080. Vi skal bruge dette nummer, når vi konfigurerer vores RESTful API. Nu er vi klar til at gå videre og teste vores API.

Test af vores API med Postman

Kør følgende i projektbiblioteket.

node <filename>.js

Dette vil starte API'en, hvor <filename>er startfilen, du har angivet i package.jsonfilen. Åbn derefter Postman på din pc/Mac, og klik på knappen " New" i øverste højre hjørne, og klik derefter på " Request". Når du er der, bør du se en bjælke, der siger " GET" ud for den. Her indtaster vi vores anmodnings-URL. Indtast blot følgende i sektionen for anmodnings-URL og klik på " Send".

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

Du vil se " 'API is online'".

API-ruter

Til at håndtere ruter vil vi bruge Express-routeren. Hvis du ikke ved, hvad en router er, er det i bund og grund, hvordan applikationsendepunkter reagerer på klientanmodninger. Her er de ruter, vi vil opsætte som et eksempel:

• /api/numbers - Viser alle tal fra 1-10.

• /api/letters - Viser alle bogstaver fra AZ.

Nu vil vi opsætte vores første rute-middleware-struktur, som sådan.

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 dette eksempel opretter vi en situation, hvor en bruger kan anmode om summen af ​​et tal + 1 ved at angive ordformen af ​​det ved hjælp af GET-metoden. Vi bruger router.route()funktionen til at pege på hvilket nummer vi vil sende tilbage som følge heraf. Parametre er navngivet med et " :" foran dem. Vi tilgår disse parametre via req.params.

Her er et eksempel med bogstaver.

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

Vi bruger samme metode som ovenfor, men vi sender brevet tilbage med stort.

Introduktion til NGINX

NGINX er en velkendt open source-software, der bruges til webservering, omvendte proxyer, streaming og mere. Vi vil bruge NGINX til at reversere proxy vores API, for at tillade os at køre det på port 80, fordi Node.js ikke tillader forbindelser på porte mindre end 1024 uden root-adgang. Dette kan være nyttigt, når du linker dit domæne til din server.

Opsætning af NGINX

For at begynde at installere NGINX skal du køre følgende i din terminal og vente på, at installationen er fuldført.

sudo apt-get install nginx

Dernæst vil vi oprette vores webstedsfil, som NGINX vil bruge til at vende proxy vores app.

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

Udfyld filen med følgende, og derefter CTRL+ for Oat gemme 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;
       }
}

Ved at bruge den samme port, som vi kørte vores applikation på tidligere, beder vi Nginx om at omdirigere alle anmodninger fra vores IP-adresse på port 80til vores API, der kører på port 8080.

Aktiver derefter den omvendte proxy ved at symlinke vores nyoprettede fil til sites-availablemappen:

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

Dette vil sikre, at NGINX vil reversere proxy vores API.

Kør først med NGINX

Når vi har afsluttet vores NGINX-konfiguration, starter vi NGINX og starter derefter vores API. Genstart først NGINX.

sudo systemctl restart nginx

Skift derefter tilbage til din API-mappe, og start den.

node <filename>.js

Applikationen kører på port 80. Kør blot testen fra oven med Postman for at sikre, at alt fungerer korrekt.

Holder vores API kørende

I et produktionsmiljø vil du gerne sikre dig, at du har en procesleder til dine Node-applikationer, for at sikre, at de forbliver kørende for evigt i baggrunden. I denne vejledning vil vi bruge en procesmanager kaldet PM2 (Process Manager 2), som er en procesmanager for Node.js-applikationer, der vil holde dem i live for evigt med minimal nedetid. PM2 kommer med mange nyttige administrationsværktøjer, såsom stop, genindlæsning, pause og mere. For at installere PM2 skal du skrive følgende og vente på, at den installeres.

sudo npm install pm2 -g

Når det er installeret, skal du bare sørge for, at du er i projektbiblioteket, skrive følgende, og applikationen vil blive startet.

pm2 start <filename>.js

Håndtering af vores applikation med PM2

Som nævnt tidligere har PM2 nogle nyttige værktøjer, som du kan bruge til bedre at administrere din applikation.

• pm2 stop- Som navnet antyder, giver dette dig mulighed for at stoppe den aktuelt kørende applikation og dræbe dens proces. Hvis din applikation giver et uventet resultat, vil det være nyttigt at stoppe den.

• pm2 list- Listefunktionen giver dig mulighed for at se alle de aktuelt kørende applikationer via PM2, kortlagt efter deres navne. Hvis du hurtigt skal tjekke din applikations oppetid, bør du bruge dette værktøj.

• pm2 restart- Hvis din applikation fryser af en eller anden grund, og du gerne vil genindlæse den, gør pm2 genstart netop det. Det vil dræbe ansøgningsprocessen og starte den igen under en anden proces.

• pm2 monit- PM2's indbyggede monitorværktøj giver dig mulighed for at se en graf over din applikations specifikke detaljer, såsom CPU/RAM-brug, i en brugervenlig graf i ncurses-stil. Dette er nyttigt, hvis du gerne vil have et visuelt billede af din applikations belastning.

Afsluttende bemærkninger

Vi har nu fuldført vores opgave med at skabe en RESTful API ved at bruge Node.js, Express og omvendt proxying med NGINX. Du er velkommen til at udvide denne tutorial. Du kan gøre mange gode ting med din nye API, såsom tilføje autentificeringsmetoder, en database, bedre rute- og fejlhåndtering og meget, meget mere. Hvis du har et domæne, med en "A"-record allerede sat op til din IP-adresse, så vil du være i stand til at få adgang til din API fra dit domæne. Hvis du vil lære mere om Express.js, kan du besøge deres hjemmeside på http://expressjs.com . Besøg http://nginx.com for at lære mere om NGINX og omvendt proxy . For at læse mere om PM2, besøg deres side på http://pm2.keymetrics.io .