企业官网建设流程全解析

嵌套路由中如何传递参数?nest-router打造标准RESTful API完整指南

【免费下载链接】nest-routerRouter Module For Nestjs Framework 🚦 🚀项目地址: https://gitcode.com/gh_mirrors/ne/nest-router

nest-router 是一款面向 NestJS 框架的路由模块（Router Module），它能帮你用一棵清晰的"路由树"来组织 API 路由。本指南将手把手讲解嵌套路由中如何传递参数：通过:参数名语法把父级资源 ID 下沉到子模块控制器中，让你快速搭建出规范、易维护的标准 RESTful API 🚀

一、nest-router 是什么？为什么适合新手？

在传统 NestJS 项目中，每个 Controller 都要手动写死完整前缀，模块多了之后路由容易混乱。nest-router 的思路是：给每个模块定义一个 path 前缀，子模块自动继承父模块前缀，从而天然形成层级化的 RESTful 路由结构。

比如CatsModule挂在NinjaModule之下，它的 Controller 前缀就不再是/cats，而是/ninja/cats——这正是标准 RESTful 资源嵌套的核心形态。

提示：自 NestJSv8.0.0起，该模块能力已被并入@nestjs/core，但仍可在 Nest 4.5.10+ 中使用本包。

二、一键安装与路由树搭建步骤

安装非常简单，一条命令即可：

npm install nest-router --save

接下来把所有路由集中定义在一个文件里（推荐单独建routes.ts），参考项目示例 routes.ts：

const routes: Routes = [ { path: '/ninja', module: NinjaModule, children: [ { path: '/cats', module: CatsModule }, { path: '/dogs', module: DogsModule }, ], }, ];

然后在根模块中导入即可，见 app.module.ts：

@Module({ imports: [RouterModule.forRoutes(routes), CatsModule, DogsModule, NinjaModule], }) export class ApplicationModule {}

最终得到的路由树如下，结构一目了然：

ninja ├── / ├── /katana ├── cats │ ├── / │ └── /ketty └── dogs ├── / └── /puppy

路由的数据结构定义在 routes.interface.ts，path、module、children三个字段就足以描述任意深度的路由树。

三、嵌套路由中如何传递参数：核心玩法

这是本文的重点 ✅ 在标准 REST API 中，子资源通常要携带父资源 ID，例如"某个忍者的猫"就是/ninja/1/cats。

3.1 在路由路径中声明 :参数名

只需在子模块的path里加上:参数名前缀：

const routes: Routes = [ { path: '/ninja', module: NinjaModule, children: [ { path: '/:ninjaId/cats', module: CatsModule }, { path: '/:ninjaId/dogs', module: DogsModule }, ], }, ];

这样ninjaId就会自动成为CatsModule、DogsModule内所有路由的一部分。

3.2 在控制器中用 @Param() 读取参数

在子模块的控制器方法里，用 NestJS 的@Param()装饰器取值即可：

@Controller() export class CatsController { @Get('/') findAll(@Param('ninjaId') ninjaId: string) { return `忍者 ${ninjaId} 的猫列表`; } }

参数在整条路径中只会声明一次，子层级无需重复定义，这是嵌套路由传参最优雅的地方。

3.3 进阶：用 Pipe 把 ID 转成完整对象

拿到ninjaId之后，还可以挂一个 Type Validation/Transformation Pipe，把字符串 ID 自动转换成数据库里的 Ninja 实体，控制器里直接拿到对象，代码更干净。

四、最快解析控制器完整路径：resolvePath 方法

中间件绑定 Controller 时，NestJS 默认不会识别模块前缀（MODULE_PATH 元数据）。nest-router 提供了RouterModule.resolvePath()帮你解析完整路径，核心实现在 router.module.ts：

// ❌ 前缀缺失 consumer.apply(someMiddleware).forRoutes(SomeController); // ✅ 自动拼上模块前缀 consumer.apply(someMiddleware).forRoutes(RouterModule.resolvePath(SomeController));

项目中LoggerMiddleware的使用示例可以参考 app.module.ts 与 logger.middleware.ts。

五、关键源码与项目结构导读 📚

展平逻辑的关键点：递归遍历children时，把子path与父path拼接（父前缀 + 子路径），再写入模块的MODULE_PATH元数据，NestJS 后续据此为控制器生成最终路由。

六、最佳实践清单

1. 路由集中管理：所有routes放在独立文件（如routes.ts），避免散落各处
2. 参数命名语义化：用:userId/cats/:catId这类资源名命名，RESTful 风格清晰
3. 配合 Pipe 校验：对数字型 ID 使用ParseIntPipe或自定义 Pipe，提前拦截非法参数
4. 多层嵌套同样适用：children支持任意深度，每一层都能携带自己的参数
5. 升级注意：NestJS 8+ 用户可直接使用官方内置能力，API 与本包高度一致

按以上步骤，你就掌握了 nest-router 在嵌套路由中传递参数的完整用法，可以轻松搭建出结构清晰、符合 RESTful 规范的 API 项目 🎉

【免费下载链接】nest-routerRouter Module For Nestjs Framework 🚦 🚀项目地址: https://gitcode.com/gh_mirrors/ne/nest-router