인프런 커뮤니티 질문&답변

박정근님의 프로필 이미지
박정근

작성한 질문수

탄탄한 백엔드 NestJS, 기초부터 심화까지

NestJS와 fastify & 협업을 위한 API 문서 만들기, CORS 문제

postman 응답 처럼 swagger 에서도 success 를 추가할수 없을까요?

해결된 질문

작성

·

881

3

export class ResultDto<T> {
  @ApiProperty()
  success: boolean;

  @ApiProperty()
  data: T
}

// ---- cats.controller.ts

@ApiResponse({
  type: ResultDto<ReadOnlyCatDto>
})
@Post()
async signUp(@Body() body: CatRequestDto) {
    return await this.catsService.signUp(body);
}


이런 식으로 단순하고 typescript 의 제네릭으로 해봤는데 안되어 질문들입니다.

답변 1

4

윤상석님의 프로필 이미지
윤상석
지식공유자

안녕하세요! 박정근님 :)

해당하는 결과를 얻고 싶으시다면 추가적인 작업이 필요합니다.

먼저 이 상황에서

아래와 같이 커스텀 데코레이터를 정의합니다.

이런식으로 swagger를 확장해서 사용하면 됩니다!

관련해서 좋은 포스팅이 있으니 참고하시면 좋을 것 같습니다.

https://nartc.me/blog/nestjs-swagger-generics

또한, 세부적인 정보는 swagger 공식 기술 문서에서 얻을 수 있습니다!

https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/

 

 

 

박정근님의 프로필 이미지
박정근

작성한 질문수

질문하기