Jak vytvořit Node.js RESTful API pomocí Express.js na Ubuntu 16.04 LTS

Instalace Postmana

Instalace Node.js

Inicializace našeho projektu Node.js

Nastavení Express.js

Spouštíme náš hlavní soubor

Testování našeho API s Postmanem

API trasy

Úvod do NGINX

Nastavení NGINX

První spuštění s NGINX

Udržování našeho API v chodu

Správa naší aplikace pomocí PM2

Závěrečné poznámky

V tomto tutoriálu se naučíte, jak nastavit kompletní RESTful API, které bude obsluhovat požadavky HTTP pomocí Node.js a Express při reverzní proxy s NGINX na Ubuntu 16.04 LTS. Budeme využívat aplikaci s názvem Postman, velmi známý nástroj pro vývoj API, k testování našeho API a ujištění se, že je plně funkční a správně funguje. Node.js je rychlý JavaScriptový framework pro více platforem založený na enginu Chrome V8. Používá se v desktopových i serverových aplikacích a je známý svým zpracováním jednovláknové smyčky událostí. Node.js budeme používat jako backend pro naše RESTful API, které je součástí Express.js, naší webové aplikace vytvořené pro Node.js. Express.js je vydán jako bezplatný a otevřený software. Express je na straně serveru, je napsán v JavaScriptu a je navržen pro vytváření rozhraní API, díky čemuž je ideální pro náš projekt. Na druhou stranu je Postman velmi výkonný HTTP klient s ohledem na vývoj API. Obsahuje všechny nástroje, které byste mohli chtít pro vývoj API.

Instalace Postmana

Nejprve chcete přejít na web Postmana a stáhnout a nainstalovat Postman pro svůj hlavní počítač (ne váš server). Všechny pokyny k instalaci budou na jejich webových stránkách.

Instalace Node.js

Nejprve budeme muset nainstalovat Node.js, abychom mohli začít vyvíjet naše API. Budeme stahovat a instalovat Node.js z oficiálních stránek.

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

Kromě toho budete také chtít získat potřebné nástroje pro sestavení, které vám pomohou při sestavování modulů.

sudo apt-get install build-essential

V tomto tutoriálu budeme používat LTS verzi Node.js, což je verze 8.9.3.

Inicializace našeho projektu Node.js

Budeme muset inicializovat nový projekt Node.js, který bude obsahovat aplikaci. Chcete-li to provést, vytvořte nový adresář.

 mkdir expressapi 

Přejděte do nového adresáře. Jakmile jste uvnitř, spusťte npm inita vyplňte všechny požadované výzvy. Poznamenejte si „vstupní bod“ vaší aplikace: tento soubor vytvoříte později. Jakmile budete hotovi, uvidíte package.jsonsoubor ve vašem aktuálním adresáři. Funguje jako popis našeho projektu a uvádí všechny závislosti potřebné k fungování.

Nastavení Express.js

Nyní nakonfigurujeme Express.js a jeho závislosti.

npm install express

Začne proces instalace. Dokončení stahování bude trvat několik minut.

Spouštíme náš hlavní soubor

Dále vytvoříme náš hlavní startovací soubor pro naše API. Zde použijete „vstupní bod“, který jste viděli v package.jsonsouboru. V zájmu tohoto tutoriálu použiji výchozí schéma pojmenování, index.js.

touch index.js

Poté jej otevřete v textovém editoru nano.

nano index.js

V našem hlavním souboru chceme nejprve zavolat všechny naše hlavní balíčky a zaregistrovat naše trasy.

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 podstatě to, co zde děláme, je inicializace naší aplikace a nastavení základního routeru pro naše API. Všimněte si, že jsme nastavili port naší aplikace na 8080. Toto číslo budeme potřebovat při konfiguraci našeho RESTful API. Nyní jsme připraveni začít testovat naše API.

Testování našeho API s Postmanem

V adresáři projektu spusťte následující.

node <filename>.js

Tím se spustí API, kde <filename>je počáteční soubor, který jste zadali v package.jsonsouboru. Poté otevřete Postman na vašem PC/Mac a klikněte na tlačítko „ New“ v pravém horním rohu a poté klikněte na „ Request“. Když tam je, měli byste vedle něj vidět pruh s nápisem „ GET“. Zde zadáme URL našeho požadavku. Jednoduše zadejte následující do části adresy URL požadavku a klikněte na „ Send“.

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

Uvidíte „ 'API is online'“.

API trasy

Ke zpracování tras budeme používat Express router. Pokud nevíte, co je router, jde v podstatě o to, jak koncové body aplikace reagují na požadavky klientů. Zde jsou trasy, které nastavíme jako příklad:

• /api/numbers - Zobrazí všechna čísla od 1 do 10.

• /api/letters - Zobrazí všechna písmena z AZ.

Nyní nastavíme naši první strukturu middlewaru trasy, podobně.

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 tomto příkladu jsme nastavili situaci, kdy uživatel může požádat o součet čísla + 1 zadáním jeho slovního tvaru pomocí metody GET. Pomocí router.route()funkce ukážeme na to, jaké číslo chceme ve výsledku poslat zpět. Parametry jsou pojmenovány s " :" před nimi. K těmto parametrům přistupujeme pomocí req.params.

Zde je příklad s písmeny.

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

Použijeme stejnou metodu jako výše, ale dopis posíláme zpět jako velký.

Úvod do NGINX

NGINX je známý software s otevřeným zdrojovým kódem používaný pro webové služby, reverzní proxy, streamování a další. NGINX budeme využívat k reverznímu proxy našeho API, abychom jej mohli spouštět na portu 80, protože Node.js neumožňuje připojení na portech nižších než 1024 bez přístupu root. To se může hodit při propojování vaší domény s vaším serverem.

Nastavení NGINX

Chcete-li zahájit instalaci NGINX, budete muset ve svém terminálu spustit následující a počkat na dokončení instalace.

sudo apt-get install nginx

Dále budeme chtít vytvořit soubor našeho webu, který NGINX použije k obrácení proxy naší aplikace.

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

Vyplňte soubor následujícím a poté CTRL+ Opro uložení.

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

Pomocí stejného portu, na kterém jsme spustili naši aplikaci dříve, říkáme Nginx, aby přesměroval všechny požadavky z naší IP adresy na portu 80na naše API běžící na portu 8080.

Dále povolte reverzní proxy symbolickým propojením našeho nově vytvořeného souboru do sites-availablesložky:

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

To zajistí, že NGINX bude reverzní proxy naše API.

První spuštění s NGINX

Jakmile dokončíme konfiguraci NGINX, spustíme NGINX a poté spustíme naše API. Nejprve restartujte NGINX.

sudo systemctl restart nginx

Poté se vraťte zpět do adresáře API a spusťte jej.

node <filename>.js

Aplikace poběží na portu 80. Jednoduše spusťte test shora pomocí Postman, abyste se ujistili, že vše funguje správně.

Udržování našeho API v chodu

V produkčním prostředí se chcete ujistit, že máte správce procesů pro aplikace Node, abyste zajistili, že zůstanou navždy spuštěny na pozadí. V tomto tutoriálu budeme používat správce procesů s názvem PM2 (Process Manager 2), což je správce procesů pro aplikace Node.js, který je udrží při životě navždy s minimálními prostoji. PM2 přichází s mnoha užitečnými nástroji pro správu, jako je zastavení, opětovné načtení, pozastavení a další. Chcete-li nainstalovat PM2, zadejte následující a počkejte, až se nainstaluje.

sudo npm install pm2 -g

Jakmile je nainstalován, vše, co musíte udělat, je ujistit se, že jste v adresáři projektu, zadejte následující a aplikace se spustí.

pm2 start <filename>.js

Správa naší aplikace pomocí PM2

Jak již bylo zmíněno dříve, PM2 má několik užitečných nástrojů, které můžete použít k lepší správě vaší aplikace.

• pm2 stop- Jak název napovídá, umožňuje vám to zastavit aktuálně spuštěnou aplikaci a ukončit její proces. Pokud vaše aplikace přináší neočekávaný výsledek, bude se hodit její zastavení.

• pm2 list- Funkce seznamu vám umožňuje zobrazit všechny aktuálně spuštěné aplikace prostřednictvím PM2, mapované podle jejich názvů. Pokud potřebujete rychle zkontrolovat dostupnost své aplikace, měli byste použít tento nástroj.

• pm2 restart- Pokud vaše aplikace z nějakého důvodu zamrzne a vy byste ji chtěli znovu načíst, pm2 restart to udělá. Zabije proces aplikace a spustí jej znovu pod jiným procesem.

• pm2 monit- Vestavěný monitorovací nástroj PM2 vám umožňuje zobrazit graf specifických detailů vaší aplikace, jako je využití CPU/RAM, v uživatelsky přívětivém grafu ve stylu ncurses. To je užitečné, pokud chcete vizuální obrázek zatížení vaší aplikace.

Závěrečné poznámky

Nyní jsme dokončili náš úkol vytvořit RESTful API s využitím Node.js, Express a reverzní proxy s NGINX. Neváhejte a rozšiřte tento tutoriál. S vaším novým API můžete dělat mnoho skvělých věcí, jako je přidání metod ověřování, databáze, lepší zpracování tras a chyb a mnohem, mnohem více. Pokud máte doménu s již nastaveným záznamem „A“ pro vaši IP adresu, budete mít přístup ke svému API ze své domény. Pokud se chcete o Express.js dozvědět více, navštivte jejich web na http://expressjs.com . Chcete-li se dozvědět více o NGINX a reverzním proxy, navštivte http://nginx.com . Chcete-li si přečíst více o PM2, navštivte jejich stránku na adrese http://pm2.keymetrics.io .