如何使用 NestJS 创建带参数的嵌套路由

Question

我需要构建一个 API，其中大多数路由都以一个公共 URL 部分为前缀，该部分也有一个参数。

在我的具体情况下，我的路线需要如下所示：

/accounts/:account/resource1/:someParam

/accounts/:account/resource2/:someParam/whatever

/accounts/:account/resource3/

/accounts/:account/resource4/subResource/

等等..

所以理想情况下，我会创建一个父路由/accounts/:account/ ，它将包含子路由（ resource1 、 resource2 、 resource3 、 resource4等...）。

我还需要可以从所有子路由访问:account参数。

使用 NestJS 实现这一目标的最佳方法是什么？

Answer 1

关于您的用例，您可能想看看这个路由器模块
=> https://github.com/shekohex/nest-router

按照这个模块的文档，你可以像这样定义你的路由：

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

@Module({
  imports: [
      RouterModule.forRoutes(routes), // setup the routes
      CatsModule,
      DogsModule,
      NinjaModule
      ], // as usual, nothing new
})
export class ApplicationModule {}

当然，路由将在一个单独的文件中定义，例如routes.ts

鉴于您有一个按模块的控制器，前面的代码将在以下路由树中结束：

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

示例：如果您想访问ketty控制器的路由，您将需要访问此端点：
<your-api-host>/ninja/cats/ketty

---

更新如果您使用 NestJs v8.0.0或更高版本，这种方法今天已经过时，因为nest-router的文档告诉我们它现在包含在@nestjs/core

并且正如@yehonatan yehezkel 所指出的那样，您可以在此处遵循推荐方法的文档https://docs.nestjs.com/recipes/router-module

Answer 2

我想你需要这个？

import {Controller, Get, Param} from "@nestjs/common";

@Controller('accounts/:account')
export class TestController{

    @Get('resource2/:someParam/whatever')
    arsPW(@Param('account') account, @Param('someParam') someparam){
        console.log(':account/resource2/:someParam/whatever',account,someparam)
        return account+'_'+someparam+'___';
    }

    @Get('resource1/:someparam')
    aRSP(@Param('account') account, @Param('someparam') someparam){
        console.log(':account/resource1/:someParam',account,someparam)
        return account+'_'+someparam;
    }


    @Get()
    getget(){
        console.log('get');
        return 'aaa';
    }

}

Answer 3

父控制器：

@Controller('accounts')
export class AccountsController {
  // http://api.domaine.com/accounts
  @Get()

儿童控制器：

@Controller('accounts/:id')
export class ResourcesController {
  // http://api.domaine.com/accounts/1/resources
  @Get('resources')

Answer 4

你可以简单地做到这一点

@Controller('trainer/:trainerId/heroes')
 export class HeroesController {
    constructor(private readonly heroesService: HeroesService) {}

    @Get(':id')
    findOne(@Param('trainerId') trainerId:string,@Param('id') id: string) {
       return `This action returns a #${id} hero trainer id ${trainerId}`;
    }

 }

uri是：

http://localhost:3000/trainer/4/heroes/5

结果是

This action returns a #5 hero trainer id 4