ApiResponse

• Response에는 다양한 응답이 존재한다. 이를 Swagger decorator를 통해서 지원한다.

예시 코드

@Post()
@ApiCreatedResponse({ description: 'The record has been successfully created.'})
@ApiForbiddenResponse({ description: 'Forbidden.'})
async create(@Body() createCatDto: CreateCatDto) {
  this.catsService.create(createCatDto);
}

@ApiCreatedResponse 는 StatusCode가 201일때의 Response를 Swagger에서 보여준다.

• 또한, Response에 대해서도 DTO Model이 적용 가능하다.

ApiOkResponse({
  schema: {
    allOf: [{ $ref: getSchemaPath(model) }],
  },
}),

• ApiOkResponse 함수를 호출하고.
• schema는 API 응답의 형식을 정의하는 객체이다.
• allof : JSON Schema 키워드로, 제공된 여러 스키마 조건을 모두 만족해야 한다는 것을 의미
• $ref : JSON Schema에서 참조를 사용하여 다른 스키마를 참조할 수 있게 하는 키워드
• getSchemaPath(model)은 참조될 스키마의 경로를 반환하는 함수 호출이다.

→ 이렇게 하여 Response의 Dto도 추가할 수 있다.