微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

@nestjs/swagger 为 GET 请求生成查询对象

如何解决@nestjs/swagger 为 GET 请求生成查询对象

我有 2 条路由,一条是 POST,它使用 @ApiBody 装饰器并正常工作,另一条是 GET,我不知道应该使用哪些装饰器来生成正确的 api。

class ImagesRequestDto {
  @ApiProperty({ type: String })
  @IsOptional()
  srch?: string

  @ApiProperty({ type: Number })
  @IsOptional()
  @Min(0)
  offset?: number

  @ApiProperty({ type: Number })
  @IsOptional()
  @Min(0)
  @Max(1000)
  limit?: number
}

// This one works:
@ApiBody({ type: ImagesRequestDto })
@ApiResponse({ status: 200,type: ImagesResponseDto })
@Post('list-post')
async listPost(@Req() request: Request,@Body() filter: ImagesRequestDto): Promise<ImagesResponseDto> {
  const [images,count] = await this.imagesService.getUserImages(filter)
  request.res.status(200)
  return { images,count }
}

// This one generates incorrect openapi:
@ApiQuery(ImagesRequestDto)
// Or @ApiQuery({ type: ImagesRequestDto,name: 'filter' })
@ApiResponse({ type: ImagesResponseDto })
@Get('list-get')
async listGet(@Query() filter: ImagesRequestDto): Promise<ImagesResponseDto> {
  const [images,count] = await this.imagesService.getUserImages(filter)
  return { images,count } 
}

我使用 @nestjs/swagger 生成 openapi.json,然后运行 ​​nswag 为前端生成 api.ts 文件。结果是:

listPost(body: ImagesRequestDto,cancelToken?: CancelToken | undefined): Promise<ImagesResponseDto> {
   ...axios request post...
}

listGet(srch: string,offset: number,limit: number,imagesRequestDto: any,cancelToken?: CancelToken | undefined): Promise<ImagesResponseDto> {
   ...axios request get...
}

所以它有 imagesRequestDto: any(为什么?)和一些来自 imagesRequestDto 的解构参数。 我希望 listGet 接受与 listPost 相同的参数 - 应该有 2 个参数,第一个query: ImagesRequestDto,第二个是 cancelToken。这更方便(特别是有很多过滤参数),因为这种情况下它可以被

使用
const images = await imagesClient.listGet(ImagesRequestDto.fromJS({..specify only required arguments..}))

代替

const images = await imagesClient.listGet(srch,first,second,third,...,offset,limit)

openapi中的get请求是否可以实现或者有什么限制?

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。