Урок 062 минуты чтения
Как разбивать маршруты через Router?
На этой странице
Кратко
Router — небольшой самостоятельный маршрутизатор Express. Он позволяет вынести адреса одного ресурса в отдельный файл и подключить их с общим префиксом.
Вопрос
Как разбить маршруты Express по файлам через Router? Как передать параметр родительского пути во вложенный роутер?
Маршруты пользователей
// src/modules/users/users.routes.ts
import { Router } from "express";
export const usersRouter = Router();
usersRouter.get("/", (request, response) => {
response.json([]);
});
usersRouter.get("/:id", (request, response) => {
response.json({ id: request.params.id });
});
usersRouter.post("/", (request, response) => {
response.status(201).json(request.body);
});Подключение:
// src/app.ts
import express from "express";
import { usersRouter } from "./modules/users/users.routes.js";
export const app = express();
app.use(express.json());
app.use("/api/users", usersRouter);Итоговые пути:
GET /api/users
GET /api/users/:id
POST /api/usersОбщий маршрутизатор API
// src/routes.ts
import { Router } from "express";
import { usersRouter } from "./modules/users/users.routes.js";
import { tasksRouter } from "./modules/tasks/tasks.routes.js";
export const apiRouter = Router();
apiRouter.use("/users", usersRouter);
apiRouter.use("/tasks", tasksRouter);app.use("/api", apiRouter);Обработчики отдельно от маршрутов
Маршрут должен показывать структуру API, а не содержать всю логику:
usersRouter.get("/", getUsers);
usersRouter.get("/:id", getUserById);
usersRouter.post("/", validateCreateUser, createUser);Так легче увидеть доступные адреса и порядок проверок.
mergeParams
Если вложенному маршрутизатору нужен параметр родителя:
app.use("/api/users/:userId/tasks", tasksRouter);export const tasksRouter = Router({ mergeParams: true });Без mergeParams: true значение userId внутри tasksRouter будет недоступно.
Что важно помнить
- Префикс задаётся при подключении (
app.use("/api/users", usersRouter)), а внутри роутера пути относительные. - Файл маршрутов показывает структуру API, логику обработчиков лучше вынести в контроллеры.
- Без
Router({ mergeParams: true })параметр родителя (:userId) внутри вложенного роутера недоступен. - Общий
apiRouterсобирает модули и подключается одной строкой вapp.ts.
Мини-шпаргалка
Router()создаёт отдельную группу маршрутов.- Префикс задаётся через
app.use()илиrouter.use(). - Маршруты одного ресурса хранятся рядом.
- Обработчики лучше выносить из файла маршрутов.
- Для параметров родительского пути нужен
mergeParams: true.
Документация
Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.