https://docs.nestjs.com/openapi/introduction

npm install --save @nestjs/swagger swagger-ui-express

  const config = new DocumentBuilder()
  .setTitle('Sleact API')
  .setDescription('Sleact 를 위한 API 문서입니다.')
  .setVersion('1.0')
  .addCookieAuth('connect.sid')
  .build();
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, document);

• 위 처럼 세팅하면 http://localhost:3000/api 위치에 스웨거 문서를 자동으로 만들어준다.

Reponse 부분

export class UserDto extends JoinRequestDto {
	@ApiProperty( {
		required: true,
		example: 1,
		description: '아이디',
	})
	id:number;
}

...
	@ApiOperation({summary: '회원가입'})
	@Post()
	postUsers(@Body() data: JoinRequestDto) {
		return (this.usersService.postUser(data));
	}

	@ApiResponse({
		status: 200,
		description: '성공',
		type: UserDto,
	})
	@ApiResponse({
		status: 500,
		description: 'Server Error',
	})
	@ApiOperation({summary: '로그인'})

Controller 위에 @ApiTags

@ApiTags('USERS')

라우트 메소드 위에 @ApiOperation (요악)

	@ApiOperation({summary: '내 정보 조회'})
	@Get()
	getUsers(@Req() req) {
		return req.user;
	}

ApiParam & ApiQuery

	@ApiParam( {
		name: 'url',
		required: true,
		description: '워크스페이스 url',
	})
	@ApiParam( {
		name: 'id',
		required: true,
		description: 'user id',
	})
	@ApiQuery( {
		name: 'perPage',
		required: true,
		description: '한번에 가져오는 개수',
	})
	@ApiQuery( {
		name: 'page',
		required: true,
		description: '불러올 페이지',
	})