如何在swagger nestjs中手动添加摘要和正文

Question

我试图在我的招摇的文档路线中添加摘要，但是我找不到合适的装饰器来定义摘要。

有些路线中我没有指定任何DTO。因此，我想为该端点手动添加请求正文。

user.controller.ts

@Controller('users')
@ApiTags('User')
@ApiBearerAuth()
export class UsersController {

  constructor(private readonly service: UsersService) {}

  @Get()
  async findAll() {
    const data = await this.service.findAll();

    return {
      statusCode: 200,
      message: 'Users retrieved successfully',
      data,
    };
  }
}

Answer 1

对于端点摘要，您可以使用@ApiOperation()。对于模式，可以使用@ApiResponse()

@Get()
@ApiOperation({ summary: 'summary goes here' })
@ApiResponse({ status: 200, description: 'description goes here', schema: { ...define schema here... } })
async findAll() {}

从此处的文档中了解有关原始定义]的更多信息：https://docs.nestjs.com/recipes/swagger#raw-definitions