Как добавить резюме и тело вручную в swagger nestjs - PullRequest
Новая
       21

Как добавить резюме и тело вручную в swagger nestjs

0 голосов
/ 07 февраля 2020

Я пытаюсь добавить сводку в маршруты документации документации, но не могу найти подходящий декоратор для определения сводки.

Есть некоторые маршруты, в которых я не указал 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,
    };
  }
}

Swagger

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);
  }

1 Ответ

1 голос
/ 10 февраля 2020

В качестве конечной точки вы можете использовать @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 -определения

...