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

Question

我试图在我的 swagger 文档 route 添加摘要，但我无法找到合适的装饰器来定义摘要。

有些路由我没有指定任何 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,
    };
  }
}

auth.controller.ts

  @UseGuards(AuthGuard('local'))
  @Post('login')
  @ApiParam({
    name: 'email',
    type: 'string'
  })
  @ApiParam({
    name: 'password',
    type: 'string'
  })

  async login(@Request() req) {
    return this.authService.login(req.user);
  }

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