nestjs - 将@ApiQuery 与nestJS 和swagger 一起使用时,有没有办法声明默认值?
问题描述
编辑:由于建议使用 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);
}
解决方案
按照评论中的建议使用 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);
}
此外,单个 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 会产生重复的参数
推荐阅读
- ios - 隐藏导航栏,在 Swift 中创建自己的后退按钮
- php - 如何使用 eloquent 在 laravel 迁移中删除 POSTGRES 表或视图?
- c++ - 使用 GCC 和 Bazel 构建时中止而不是捕获异常
- django - 如何从 django 模板中的 django ck 编辑器渲染图像并删除内容中的 html 标签
- java - 用java中的另一个数组更改原始数组
- mysql - SSL 与基于 Cloud SQL 实例的 MySQL 集成
- r - 将 100 个图像的列表转换为 R 中的数组
- git - 配置 Git LFS 后 Github Desktop 中的文件太大警告
- reactjs - Redux 商店更新异常
- java - 使用反射来验证特征的所有实例都有一个唯一的字段