将@ApiQuery 与nestJS 和swagger 一起使用时，有没有办法声明默认值？

Posted 2023-03-10

【中文标题】将@ApiQuery 与nestJS 和swagger 一起使用时，有没有办法声明默认值？

【英文标题】：Is there a way to declare a default value when using @ApiQuery with nestJS and swagger?

【发布时间】：2021-07-29 19:42:02

【问题描述】：

编辑：由于建议使用 DTO 的评论找到了解决方案。答案在底部。

NestJS 网站有使用@ApiBody() 时[声明默认值][1] 的文档，有没有使用@ApiQuery() 的方法？ （即在文档中显示查询具有默认值）

例如，如果我有分页查询并希望默认为第 1 页，每页 5 个条目：

  @Get()
  @ApiQuery(name: 'page', default: 1, type: Number)
  @ApiQuery(name: 'limit', default: 5, type: Number)
  async getDocuments(
    @Query('page') page: Number = 1, 
    @Query('limit') limit: Number = 5
  )
    return this.documentsService.getDocuments(page, limit);
  

【问题讨论】：

以上有什么问题？

以上是我想要实现的。实际上，向 ApiQuery 添加“默认”键会引发错误。

使用 DTO 来显示这些信息怎么样？

刚刚试了一下，它可以工作（编辑了原始帖子以显示我的实现），它看起来正确吗？非常感谢！

仅供参考：您可以（通常应该）发布自己问题的答案，而不是将答案编辑到问题中

【参考方案1】：

按照 cmets 中的建议使用 DTO：

//dto.ts
export class PageDTO 
  @ApiProperty(default: 1, required: false)
  page: Number

export class LimitDTO 
  @ApiProperty(default: 5, required: false)
  limit: Number

//documents.controller.ts
...
  @Get()
  @ApiQuery(name: 'page', default: 1, type: PageDTO)
  @ApiQuery(name: 'limit', default: 5, type: LimitDTO)
  async getDocuments(
    @Query('page') page = 1, 
    @Query('limit') limit = 5
  )
    return this.documentsService.getDocuments(page, limit);
  

结果： *打错了，这里默认是0，但应该是1

此外，单个 DTO 可用于多个查询参数。如果多个函数使用相同的参数，这尤其有用：

//dto.ts
export class PaginationDTO 
  @ApiProperty(default: 1, required: false)
  page: Number
  @ApiProperty(default: 5, required: false)
  limit: Number


//documents.controller.ts
...
  @Get()
  @ApiQuery(type: PaginationDTO)
  async getDocuments(
    @Query('page') page = 1, 
    @Query('limit') limit = 5 
  )
    return this.documentsService.getDocuments(page, limit);
  

还要注意我的工作示例中省略了类型声明——这是因为如果声明了类型，swagger 会产生重复的参数

【参考方案2】：

  @Get()
  @ApiQuery(name: 'page', type: Number)
  @ApiQuery(name: 'limit', type: Number)
  async getDocuments(
    @Query('page', new DefaultValuePipe(1), ParseIntPipe) page: Number = 1, 
    @Query('limit', new DefaultValuePipe(5), ParseIntPipe) limit: Number = 5
  )
    return this.documentsService.getDocuments(page, limit);