Как да създадете Node.js RESTful API с помощта на Express.js на Ubuntu 16.04 LTS

В този урок ще научите как да настроите пълен RESTful API, който ще обслужва HTTP заявки с помощта на Node.js и Express, докато го проксира обратно с NGINX, на Ubuntu 16.04 LTS. Ще използваме приложение, наречено Postman, много добре познат инструмент за разработка на API, за да тествате нашия API и да се уверите, че е напълно функционален и работи правилно. Node.js е бърза, междуплатформена JavaScript рамка, базирана на V8 двигателя на Chrome. Използва се както в настолни, така и в сървърни приложения и е известен със своята еднонишкова обработка на цикъл на събития. Ще използваме Node.js като бекенд за нашия RESTful API, в комплект с Express.js, нашата рамка за уеб приложения, изградена за Node.js. Express.js се пуска като безплатен и отворен софтуер. Express е от страна на сървъра, написан на JavaScript и е предназначен за изграждане на API, което го прави идеален за нашия проект. От друга страна, Postman е много мощен HTTP клиент, имащ предвид разработката на API. Той включва всички инструменти, които евентуално бихте искали за разработка на API.

Инсталиране на Postman

Първо, искате да отидете на уебсайта на Postman и да изтеглите и инсталирате Postman за вашия основен компютър (не вашия сървър). Всички инструкции за инсталиране ще бъдат на техния уебсайт.

Инсталиране на Node.js

За да започнем, първо ще трябва да инсталираме Node.js, за да можем да започнем да разработваме нашия API. Ще изтеглим и инсталираме Node.js от официалния уебсайт.

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

В допълнение, вие също ще искате да вземете необходимите инструменти за изграждане, които ще бъдат полезни при компилирането на модули.

sudo apt-get install build-essential

За този урок ще използваме LTS версията на Node.js, която е версия 8.9.3.

Инициализираме нашия проект Node.js

Ще трябва да инициализираме нов проект Node.js, който ще съдържа приложение. За да направите това, създайте нова директория.

 mkdir expressapi 

Променете към новата директория. След като влезете, стартирайте npm initи попълнете всички необходими подкани. Обърнете внимание на "входната точка" на вашето приложение: ще създадете този файл по-късно. След като приключите, ще видите package.jsonфайл в текущата си директория. Той действа като описание на нашия проект и изброява всички зависимости, необходими за функциониране.

Настройка на Express.js

Сега ще конфигурираме Express.js и неговите зависимости.

npm install express

Процесът на инсталиране ще започне. Ще отнеме няколко минути, докато всичко завърши изтеглянето.

Стартиране на нашия основен файл

След това ще създадем нашия основен начален файл за нашия API. Ето къде ще използвате "входната точка", която сте видели във package.jsonфайла. В името на този урок ще използвам схемата за именуване по подразбиране, index.js.

touch index.js

След това го отворете в нано текстовия редактор.

nano index.js

В нашия основен файл искаме първо да извикаме всички наши основни пакети и да регистрираме нашите маршрути.

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

По принцип това, което правим тук, е да инициализираме нашето приложение и да настроим основен рутер за нашия API. Имайте предвид, че ние задаваме порта на нашето приложение на 8080. Ще ни трябва този номер, когато конфигурираме нашия RESTful API. Сега сме готови да продължим и да тестваме нашия API.

Тестване на нашия API с Postman

В директорията на проекта изпълнете следното.

node <filename>.js

Това ще стартира API, където <filename>е началният файл, който сте посочили във package.jsonфайла. След това отворете Postman на вашия компютър/Mac и щракнете върху бутона " New" в горния десен ъгъл, след което щракнете върху " Request". Когато сте там, трябва да видите лента с надпис " GET" до нея. Тук ще въведем URL на нашата заявка. Просто въведете следното в секцията URL на заявката и щракнете върху " Send".

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

Ще видите " 'API is online'".

API маршрути

За да обработваме маршрути, ще използваме експресния рутер. Ако не знаете какво е рутер, по същество това е как крайните точки на приложението отговарят на клиентски заявки. Ето маршрутите, които ще настроим като пример:

• /api/numbers - Показва всички числа от 1-10.

• /api/letters - Показва всички букви от AZ.

Сега ще настроим първата ни структура на междинен софтуер за маршрут, ето така.

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

В този пример ние настроихме ситуация, при която потребителят може да поиска сумата от число + 1, като предостави словната му форма, използвайки метода GET. Използваме router.route()функцията, за да посочим кой номер искаме да изпратим обратно като резултат. Параметрите се именуват с " :" пред тях. Ние осъществяваме достъп до тези параметър(и) чрез req.params.

Ето пример с букви.

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

Използваме същия метод като по-горе, но изпращаме обратно писмото с главни букви.

Въведение в NGINX

NGINX е добре познат софтуер с отворен код, използван за уеб обслужване, обратни прокси сървъри, стрийминг и др. Ще използваме NGINX, за да о��ърнем прокси нашия API, за да ни позволи да го стартираме на порт 80, тъй като Node.js не позволява връзки на портове под 1024 без root достъп. Това може да бъде полезно, когато свързвате вашия домейн с вашия сървър.

Настройка на NGINX

За да започнете да инсталирате NGINX, ще трябва да стартирате следното във вашия терминал и да изчакате инсталацията да завърши.

sudo apt-get install nginx

След това ще искаме да създадем нашия файл на сайта, който NGINX ще използва за обратно прокси на нашето приложение.

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

Попълнете файла със следното, след което 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;
       }
}

Използвайки същия порт, на който стартирахме нашето приложение по-рано, ние казваме на Nginx да пренасочи всички заявки от нашия IP адрес на порт 80към нашия API, работещ на порт 8080.

След това активирайте обратния прокси, като символизирате нашия новосъздадения файл към sites-availableпапката:

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

Това ще гарантира, че NGINX ще обърне прокси на нашия API.

Първо стартиране с NGINX

След като приключим с конфигурацията на NGINX, ще стартираме NGINX, след което ще стартираме нашия API. Първо, рестартирайте NGINX.

sudo systemctl restart nginx

След това се върнете обратно към вашата директория на API и я стартирайте.

node <filename>.js

Приложението ще работи на порт 80. Просто стартирайте теста отгоре с Postman, за да се уверите, че всичко работи правилно.

Поддържане на нашия API да работи

В производствена среда искате да сте сигурни, че имате мениджър на процеси за вашите приложения на Node, за да сте сигурни, че те ще работят завинаги във фонов режим. В този урок ще използваме мениджър на процеси, наречен PM2 (Process Manager 2), който е мениджър на процеси за приложения Node.js, който ще ги поддържа живи завинаги с минимално време на престой. PM2 идва с много полезни инструменти за управление, като спиране, презареждане, пауза и др. За да инсталирате PM2, въведете следното и изчакайте да се инсталира.

sudo npm install pm2 -g

След като бъде инсталиран, всичко, което трябва да направите, е да се уверите, че сте в директорията на проекта, да въведете следното и приложението ще бъде стартирано.

pm2 start <filename>.js

Управление на нашето приложение с PM2

Както споменахме по-рано, PM2 има някои полезни инструменти, които можете да използвате за по-добро управление на вашето приложение.

• pm2 stop- Както подсказва името, това ви позволява да спрете текущо работещото приложение и да прекратите процеса му. Ако приложението ви дава неочакван резултат, спирането му ще бъде полезно.

• pm2 list- Функцията за списък ви позволява да видите всички текущо работещи приложения чрез PM2, картографирани с техните имена. Ако трябва бързо да проверите времето за работа на приложението си, трябва да използвате този инструмент.

• pm2 restart- Ако приложението ви замръзне по някаква причина и искате да го презаредите, pm2 рестарт прави точно това. Той ще убие процеса на кандидатстване и ще го стартира отново, под различен процес.

• pm2 monit- Вграденият инструмент за монитор на PM2 ви позволява да видите графика на специфичните детайли на вашето приложение, като например използване на CPU/RAM, в удобна за потребителя графика в стил ncurses. Това е полезно, ако искате визуална картина на натоварването на вашето приложение.

Заключителни забележки

Вече завършихме задачата си да създадем RESTful API, използвайки Node.js, Express и обратното му прокси с NGINX. Чувствайте се свободни да разширите този урок. Можете да правите много страхотни неща с новия си API, като например добавяне на методи за удостоверяване, база данни, по-добър маршрут и обработка на грешки и много, много повече. Ако имате домейн, със запис "A" вече настроен към вашия IP адрес, тогава ще можете да получите достъп до вашия API от вашия домейн. Ако искате да научите повече за Express.js, посетете техния уебсайт на адрес http://expressjs.com . За да научите повече за NGINX и обратното прокси, посетете http://nginx.com . За да прочетете повече за PM2, посетете тяхната страница на адрес http://pm2.keymetrics.io .