Як створити Node.js RESTful API за допомогою Express.js в Ubuntu 16.04 LTS

Установка Postman

Встановлення Node.js

Ініціалізація нашого проекту Node.js

Налаштування Express.js

Запускаємо наш основний файл

Тестування нашого API за допомогою Postman

Маршрути API

Знайомство з NGINX

Налаштування NGINX

Перший запуск з NGINX

Підтримка роботи нашого API

Керування нашим додатком за допомогою PM2

Заключні зауваження

У цьому підручнику ви дізнаєтеся, як налаштувати повний RESTful API, який обслуговуватиме HTTP-запити за допомогою Node.js і Express, а також зворотне проксі-проксі за допомогою NGINX в Ubuntu 16.04 LTS. Ми будемо використовувати програму під назвою Postman, дуже відомий інструмент розробки API, щоб перевірити наш API і переконатися, що він повністю функціональний і працює належним чином. Node.js – це швидка міжплатформна платформа JavaScript на основі двигуна Chrome V8. Він використовується як у настільних, так і в серверних програмах і відомий своєю однопоточною обробкою циклу подій. Ми будемо використовувати 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.

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 - Показує всі листи від А-Я.

Тепер ми налаштуємо нашу першу структуру проміжного програмного забезпечення маршруту, ось так.

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, щоб дозволити нам запустити його на port 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 restart робить саме це. Це припинить процес застосування та запустить його знову, під іншим процесом.

• pm2 monit- Вбудований інструмент моніторингу PM2 дозволяє переглядати графік конкретних деталей вашої програми, наприклад, використання ЦП/ОЗУ, у зручному для користувача графіку в стилі ncurses. Це корисно, якщо ви хочете отримати візуальне зображення завантаження вашої програми.

Заключні зауваження

Тепер ми завершили наше завдання зі створення RESTful API, використовуючи Node.js, Express, і зворотне проксі-проксі за допомогою NGINX. Не соромтеся розширити цей посібник. Ви можете зробити багато чудових речей із своїм новим API, наприклад, додати методи автентифікації, базу даних, покращити обробку маршрутів і помилок і багато-багато іншого. Якщо у вас є домен із записом «А», уже налаштованим на вашу IP-адресу, ви зможете отримати доступ до свого API зі свого домену. Якщо ви хочете дізнатися більше про Express.js, відвідайте їхній веб-сайт за адресою http://expressjs.com . Щоб дізнатися більше про NGINX та зворотне проксі, відвідайте http://nginx.com . Щоб дізнатися більше про PM2, відвідайте їх сторінку за адресою http://pm2.keymetrics.io .