Как создать REST API в Node.js

В этой статье мы увидим сквозной процесс создания базового API для отдыха в Node.js.
Мы начнем с абсолютного базового уровня, чтобы у вас не возникло никаких проблем.

Давайте начнем.

1. Создайте базовый проект узла, используя приведенную ниже команду.

npm init -y

npm install express

const express = require('express');

const app = express();

app.listen(3000, () => {
  console.log('Server is running on Port 3000');
});

node server.js

Это базовая структура, необходимая для настройки приложения узла.

Теперь мы создадим простой API-интерфейс для получения , который будет возвращать простую строку — «Добро пожаловать в конечную точку Hello».

Создайте папку маршрутизатора в том же проекте и создайте файл applicationRoute.js с содержимым, указанным ниже.

const express = require('express');      // Step 1 

const router = express.Router();   // Step 2

router.get('/getHello', helloController);   // Step 3

module.exports = router;   // Step 4

1. Импорт экспресса в локальную переменную.
2. Это самый важный шаг при разработке маршрутов с экспрессом. Express предоставляет функцию маршрутизатора, которая помогает в создании объекта маршрутизатора для эффективного создания конечных точек. Здесь мы сохраняем объект в переменной маршрутизатора.
3. Далее мы будем использовать объект маршрутизатора, созданный на шаге 2, для создания желаемой конечной точки. На изображении ниже показана анатомия полного синтаксиса.

4. Объект маршрутизатора — это объект, созданный на шаге 2.
5. Глагол Http — это традиционное действие http, которое может быть чем угодно, например GET, POST, PUT или DELETE.
6. Строка конечной точки — это наша конечная точка, которую мы хотим создать.
7. Контроллер — это функция, в которой мы реализуем бизнес-логику для конечной точки, например манипулирование данными и т. д., и отправляем отсюда ответ.
8. Мы также можем использовать несколько функций промежуточного программного обеспечения, подобных контроллеру, но в этой статье мы не будем углубляться в промежуточное программное обеспечение.

Измените server.js и добавьте указанные ниже новые строки, чтобы мы настроили желаемый маршрут к созданным маршрутам (в нашем случае — applicationRoutes).

const express = require('express');
const router = require('./Routes/applicationRoutes');   // Step 1 

const app = express();   

app.use('/demo', router);                           // Step 2

app.listen(3000, () => {
  console.log('Server is running on Port 3000');
});

1. Используйте маршрутизатор для маршрутизации всей логики нашего приложения, указывающей на «демонстрационный» маршрут, на нашу логику маршрутизатора.

Все наши концы подключены, кроме одного, и это контроллер ( самый важный ). Давайте сделаем это сейчас.

Создайте папку, параллельную папке маршрутов, и создайте файл с именем applicationController.js и добавьте в приведенную ниже логику.

module.exports = {
  helloController: (req, res) => {
    res.status(200).send('Welcome to Hello End point'); // Step 1
  },
};

Теперь давайте вместе посмотрим все в действии через почтальон.



Как видно из вышеизложенного, мы можем успешно получить ответ, как и ожидалось.

Надеюсь, вы смогли получить общее представление о том, как создать конечную точку в NodeJS, используя экспресс. Полный код можно посмотреть по ссылке .

В следующем уроке мы углубимся и поймем, как создать конечную точку POST.
Если у вас есть какие-либо вопросы, дайте мне знать в ответ.

Обо мне — я энтузиаст программирования, который любит читать и писать о внешнем дизайне, JavaScript и вещах, связанных с UI/UX. Нажмите здесь, чтобы прочитать все мои статьи и дайте мне знать ваши отзывы.

Больше контента на PlainEnglish.io . Подпишитесь на нашу бесплатную еженедельную рассылку . Следите за нами в Twitter , LinkedIn , YouTube и Discord .

Заинтересованы в масштабировании запуска вашего программного обеспечения ? Проверьте Цепь .