РАЗРАБОТКА REST API С ПОМОЩЬЮ NODE.JS

Что такое REST

REST (Representational State Transfer – «передача состояния представления») – специальная веб-архитектура и HTTP протокол. REST архитектура описывает шесть ограничений, которые определяют основные правила при создании REST-стиля веб-приложения:

• Единообразный интерфейс
• Отсутствует сохранение состояния
• Возможность использовать кэш
• Клиент-серверное взаимодействие
• Система состоит из отдельных слоев
• Добавление функциональности может производиться по требованию

REST приложения используют HTPP запросы для выполнения основных операций CRUD (C: create – создать, R: read – читать, U: update – обновить, D: delete – удалить). При создании используется POST запрос, обновлении – PUT, чтении – GET, удалении – DELETE.

В данной работе мы создадим REST API, используя Node.js.

Инструменты

• Node.js
• MongoDB
• Текстовый редактор
• Postman

Создадим следующую структуру проекта:

Рисунок 1. Базовая структура проекта

Старт сервера

Установим фреймворк express и nodmon. Express будет использоваться для создания сервера, в то время как nodmon будет следить за изменениями в файлах нашего приложения автоматически делать рестарт сервера.

Необходимо выполнить в консоли две команды:

Рисунок 2. Установка express и nodmon

После успешной установки файл package.json будет содержать записи о двух новых установленных пакетах.

Теперь откроем файл server.js и добавим в него следующие строки:

Рисунок 3. Скрипт запуска сервера

Далее в консоли необходимо написать: npm run start. Эта команда запустит сервер и мы увидим следующую строку: todo list RESTful API server started on: 3000.

Создание схемы базы данных

Для начала установим mongoose: npm install mongoose  - - save. Mongoose будет использоваться для взаимодействия с базой данных MongoDB. После установки, нужно открыть файл todoListModel.js и написать следующий код:

Рисунок 4. Скрипт создания схемы базы данных

Создание контроллера

Откроем файл todoListController.js при помощи текстового редактора.

В этом контроллера у нас будет 3 различные функции: list_all_tasks, create_a_task, read_a_taks. Мы сделаем экспорт этих функций для их дальнейшего использования в наших маршрутах.

Рисунок 5. Функции контроллера

Запуск приложения

Для запуска приложения и объединения всех отдельных частей сделаем следующее:

• Подключимся к нашей базе данных, добавим url в mongoose
• Загрузим созданную модель – task
• 3арегистрируем наши маршруты в сервере

Рисунок 6. Скрипт запуска приложения

Список литературы:

1. Wikipedia [Электронный ресурс] / https://ru.wikipedia.org/wiki/REST (дата обращения 10.06.2017)
2. Codementor [Электронный ресурс] / https://www.codementor.io/olatundegaruba/nodejs-restful-apis-in-10-minutes-q0sgsfhbd (дата обращения 10.06.2017)