1

我有 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 } 
}

我生成 openapi.json ，@nestjs/swagger然后运行为前端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请求是否可以实现或有任何限制？

4

0 回答 0