当@ApiQuery与nestJS和swagger一起使用时，有没有办法声明一个默认值？
当@ApiQuery与nestJS和swagger一起使用时，有没有办法声明一个默认值？
提问于 2021-05-07 21:32:31
编辑:多亏了建议使用DTO的评论，找到了解决方案。详细答案在底部。
NestJS网站提供了在使用@ApiBody()时声明默认值的文档，有没有办法使用@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);
}Stack Overflow用户
回答已采纳
发布于 2021-05-09 01:55:07
按照注释中的建议使用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将生成重复的参数
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/67435944
复制相关文章
相似问题
腾讯云开发者
