Реализация вложенных маршрутов в Express.js для REST API

Быстрый ответ

Организация вложенной маршрутизации в Express.js осуществляется с помощью модуля express.Router(), позволяющего эффективно управлять и связывать маршруты между собой. Иерархия маршрутов с применением parentRouter и childRouter выглядит вот так:

const express = require('express');
const app = express();
const parentRouter = express.Router();
const childRouter = express.Router();

childRouter.get('/', (req, res) => res.send('Привет из дочернего роутера!'));

parentRouter.use('/child', childRouter);
app.use('/', parentRouter);

app.listen(3000);

Понятие mergeParams в контексте вложенных роутеров

Параметр mergeParams: true модуля express.Router() помогает создавать прозрачную иерархическую структуру в RESTful API. Этот параметр обеспечивает доступ дочернего роутера к параметрам, переданным в родительский маршрут.

Применение mergeParams

Использование mergeParams иллюстрируется на примере связывания пользователя с его объектами:

const express = require('express');
const userRouter = express.Router();
const itemRouter = express.Router({ mergeParams: true });

itemRouter.get('/', (req, res) => {
  const userId = req.params.user_id;
  res.send(`Объекты пользователя с ID ${userId}`);
});

userRouter.use('/:user_id/items', itemRouter);

Подробнее об этом расскажет наш спикер на видео

Масштабирование маршрутизации

Для расширения маршрутов вместе с вашим приложением необходимо заранее организовать загрузку и использование маршрутов, рекурсивно импортируя их через require.

Модульность в структуре

Чистоту и организованность структуры можно достичь разделением маршрутов на модули:

// user/index.js
const express = require('express');
const router = express.Router();
const itemRouter = require('./item');

router.use('/:user_id/items', itemRouter);

module.exports = router;

// app.js
const userRouter = require('./routes/user');
app.use('/user', userRouter);

Советы по написанию чистого и легко поддерживаемого кода

Ясное разделение функциональности маршрутов достигается путем создания отдельных роутеров для каждой группы точек доступа, например, userRouter и itemRouter.

Использование express.Router() для получения и обработки данных пользователя

express.Router() эффективно справляется с управлением динамическими маршрутами, связанными с данными пользователя:

// user/item.js
router.get('/:item_id', (req, res) => {
  const { user_id, item_id } = req.params;
  res.send(`Объект ${item_id} получен для пользователя ${user_id}`);
});

Структуры маршрутизации: проведение линий

Сложные структуры API могут потребовать системного подхода с использованием фреймворков типа actionhero или NestJS.

Визуализация

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

Полезные материалы

1. Маршрутизация в Express — детальный обзор маршрутизации.
2. Руководство по новому роутеру в ExpressJS 4.0 — подробное руководство по работе с роутером Express.
3. Туториал по Express, часть 4: Маршруты и контроллеры — обзор MDN по организации маршрутов с помощью express.Router.
4. Структура проекта для REST API на Express, когда нет стандарта — лучшие практики структурирования приложений.
5. Создание вложенных маршрутов в Express.js – Видеоурок — инстуктивный видеоурок по реализации маршрутов.
6. Вложенные маршруты в Express с express.Router – GitHub Gist — пример создания маршрутов.