Како да креирате Ноде.јс РЕСТфул АПИ користећи Екпресс.јс на Убунту 16.04 ЛТС

У овом туторијалу ћете научити како да подесите комплетан РЕСТфул АПИ, који ће служити ХТТП захтеве користећи Ноде.јс и Екпресс, док га обрнути прокси са НГИНКС-ом, на Убунту 16.04 ЛТС. Користићемо апликацију под називом Постман, веома познати алат за развој АПИ-ја, да тестирамо наш АПИ и да се уверимо да је потпуно функционалан и да ради исправно. Ноде.јс је брз, вишеплатформски ЈаваСцрипт оквир заснован на Цхроме-овом В8 мотору. Користи се и у десктоп и у серверским апликацијама и познат је по руковању петљи са једним навојем. Користићемо Ноде.јс као позадину за наш РЕСТфул АПИ, у пакету са Екпресс.јс, нашим оквиром веб апликације направљеним за Ноде.јс. Екпресс.јс је објављен као бесплатан и отворен софтвер. Екпресс је на страни сервера, написан у ЈаваСцрипт-у и дизајниран је за прављење АПИ-ја, што га чини савршеним за наш пројекат. С друге стране, Постман је веома моћан ХТТП клијент, са развојем АПИ-ја на уму. Садржи све алате које бисте можда желели за развој АПИ-ја.

Инсталирање поштара

Прво, желите да пређете на Постман-ову веб локацију и преузмете и инсталирате Постман за свој главни рачунар (не ваш сервер). Сва упутства за инсталацију биће на њиховој веб страници.

Инсталирање Ноде.јс

За почетак, прво ћемо морати да инсталирамо Ноде.јс да бисмо могли да почнемо да развијамо наш АПИ. Ми ћемо преузети и инсталирати Ноде.јс са званичне веб странице.

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

Поред тога, такође ћете желети да зграбите неопходне алате за прављење, који ће вам бити од помоћи при састављању модула.

sudo apt-get install build-essential

За овај водич користићемо ЛТС верзију Ноде.јс, а то је верзија 8.9.3.

Иницијализација нашег пројекта Ноде.јс

Мораћемо да иницијализујемо нови Ноде.јс пројекат, који ће садржати апликацију. Да бисте то урадили, креирајте нови директоријум.

 mkdir expressapi 

Промените у нови директоријум. Када уђете, покрените npm initи довршите све потребне упите. Имајте на уму „улазну тачку“ ваше апликације: касније ћете креирати ову датотеку. Када завршите, видећете package.jsonдатотеку у вашем тренутном директоријуму. Делује као опис нашег пројекта и наводи све зависности потребне за функционисање.

Подешавање Екпресс.јс

Сада ћемо конфигурисати Екпресс.јс и његове зависности.

npm install express

Процес инсталације ће почети. Биће потребно неколико минута да се све заврши преузимање.

Покрећемо нашу главну датотеку

Затим ћемо креирати нашу главну почетну датотеку за наш АПИ. Овде ћете користити „улазну тачку“ коју сте видели у 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);

У основи, оно што радимо овде је иницијализација наше апликације и подешавање основног рутера за наш АПИ. Имајте на уму да смо порт наше апликације поставили на 8080. Овај број ће нам требати када конфигуришемо наш РЕСТфул АПИ. Сада смо спремни да наставимо и тестирамо наш АПИ.

Тестирање нашег АПИ-ја са Постман-ом

У директоријуму пројекта покрените следеће.

node <filename>.js

Ово ће покренути АПИ, где <filename>је почетна датотека коју сте навели у package.jsonдатотеци. Затим отворите Постман на свом ПЦ/Мац-у и кликните на дугме " New" у горњем десном углу, а затим кликните на " Request". Када сте тамо, требало би да видите траку која каже „ GET“ поред ње. Овде ћемо унети УРЛ нашег захтева. Једноставно унесите следеће у одељак УРЛ захтева и кликните на „ Send“.

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

Видећете " 'API is online'".

АПИ руте

За руковање рутама користићемо експрес рутер. Ако не знате шта је рутер, то је у суштини начин на који крајње тачке апликације реагују на захтеве клијената. Ево рута које ћемо поставити као пример:

• /api/numbers - Приказује све бројеве од 1-10.

• /api/letters - Приказује сва слова од АЗ.

Сада ћемо поставити нашу прву структуру средњег софтвера руте, овако.

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 тако што ће обезбедити његов облик речи, користећи ГЕТ метод. Користимо router.route()функцију да покажемо на који број желимо да пошаљемо назад као резултат. Параметри се именују са " :" испред њих. Овим параметрима приступамо преко req.params.

Ево примера са словима.

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

Користимо исти метод као горе, али писмо шаљемо као велико.

Увод у НГИНКС

НГИНКС је добро познати софтвер отвореног кода који се користи за веб сервисирање, обрнути прокси сервер, стримовање и још много тога. Користићемо НГИНКС да обрнемо прокси наш АПИ, да бисмо могли да га покренемо на порту 80, јер Ноде.јс не дозвољава везе на портовима мањим од 1024 без роот приступа. Ово може бити корисно када повезујете свој домен са сервером.

Подешавање НГИНКС-а

Да бисте започели инсталацију НГИНКС-а, мораћете да покренете следеће у свом терминалу и сачекате да се инсталација заврши.

sudo apt-get install 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;
       }
}

Користећи исти порт на којем смо раније покренули нашу апликацију, кажемо Нгинк-у да преусмери све захтеве са наше ИП адресе на порту 80на наш АПИ који ради на порту 8080.

Затим омогућите обрнути прокси тако што ћете симболично повезати нашу новокреирану датотеку у sites-availableфасциклу:

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

Ово ће осигурати да ће НГИНКС обрнути прокси наш АПИ.

Прво покретање са НГИНКС-ом

Када завршимо нашу НГИНКС конфигурацију, покренућемо НГИНКС, а затим покренути наш АПИ. Прво, поново покрените НГИНКС.

sudo systemctl restart nginx

Затим се вратите у свој АПИ директоријум и покрените га.

node <filename>.js

Апликација ће се покренути на порту 80. Једноставно покрените тест одозго са Постман-ом да бисте били сигурни да све ради како треба.

Одржавање рада нашег АПИ-ја

У производном окружењу, желите да будете сигурни да имате менаџера процеса за ваше Ноде апликације, како бисте били сигурни да ће оне заувек радити у позадини. У овом туторијалу користићемо менаџер процеса који се зове ПМ2 (Процесс Манагер 2), који је менаџер процеса за Ноде.јс апликације који ће их одржати у животу заувек са минималним застојима. ПМ2 долази са многим корисним алатима за управљање, као што су заустављање, поновно учитавање, паузирање и још много тога. Да бисте инсталирали ПМ2, откуцајте следеће и сачекајте да се инсталира.

sudo npm install pm2 -g

Када се инсталира, све што треба да урадите је да се уверите да сте у директоријуму пројекта, откуцате следеће и апликација ће бити покренута.

pm2 start <filename>.js

Управљање нашом апликацијом са ПМ2

Као што је раније поменуто, ПМ2 има неке корисне алате које можете користити за боље управљање својом апликацијом.

• pm2 stop- Као што име сугерише, ово вам омогућава да зауставите тренутно покренуту апликацију и зауставите њен процес. Ако ваша апликација даје неочекивани резултат, заустављање ће вам добро доћи.

• pm2 list- Функција листе вам омогућава да видите све тренутно покренуте апликације преко ПМ2, мапиране по њиховим именима. Ако требате брзо да проверите време рада ваше апликације, требало би да користите овај алат.

• pm2 restart- Ако се ваша апликација из неког разлога замрзне, а желите да је поново учитате, пм2 рестарт ради управо то. То ће убити процес апликације и покренути га поново, под другим процесом.

• pm2 monit- ПМ2-ов уграђени алат за надгледање вам омогућава да видите графикон специфичних детаља ваше апликације, као што је употреба ЦПУ/РАМ-а, у графичком приказу у стилу нцурсес. Ово је корисно ако желите визуелну слику оптерећења ваше апликације.

Завршне напомене

Сада смо завршили наш задатак креирања РЕСТфул АПИ-ја, користећи Ноде.јс, Екпресс, и обрнуто проки са НГИНКС-ом. Слободно проширите овај водич. Можете да урадите много сјајних ствари са својим новим АПИ-јем, као што је додавање метода аутентификације, базе података, боље руковање рутама и грешкама и још много, много више. Ако имате домен са "А" записом који је већ подешен на вашу ИП адресу, тада ћете моћи да приступите свом АПИ-ју са свог домена. Ако желите да сазнате више о Екпресс.јс, посетите њихову веб локацију на адреси хттп://екпрессјс.цом . Да бисте сазнали више о НГИНКС-у и обрнутом проксију, посетите хттп: //нгинк.цом . Да бисте прочитали више о ПМ2, посетите њихову страницу на хттп://пм2.кеиметрицс.ио .