inflearn logo
강의

강의

N
챌린지

챌린지

멘토링

멘토링

N
클립

클립

로드맵

로드맵

지식공유

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

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

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

해결된 질문

977

박정근

작성한 질문수 4

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 의 제네릭으로 해봤는데 안되어 질문들입니다.

swagger nodejs ApiResponse express mongodb NestJS ssr

답변 1

4

윤상석

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

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

먼저 이 상황에서

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

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

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

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

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

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

 

 

 

프로젝트 환경 세팅할 때 최신 노드 버젼을 사용하시는 분들은 참고하셔도 좋을 것 같아요~

2

101

1

DTO에 대한 질문

1

97

2

백엔드 MVC에서 View의 역할은 무엇인가요?

1

111

2

추가 업데이트 관련 건

0

105

2

nest js 버전문제

0

95

2

mongdb 스키마 공식 문서와 형태가 다른 이유 궁금합니다.

0

112

1

라인 끝에 에러 표시(eslint) 때문에 구글 찾아 보니.

0

83

1

전체 고양이 조회 라우터 중 error.message 오류

0

79

1

캡슐화 추가 설명 중 단일책임원칙 관련 질문

0

115

0

42강 고양이끼리 소통 댓글 구현 중 Schema hasn't been registered for model 'comments' 에러 해결

0

86

1

채팅 이슈

0

137

1

모듈이 더 이상 지원하지 않는답니다

0

215

1

오류가 있습니다

0

114

1

import 에서 오류가 납니다

0

131

1

이런 오류가 나옵니다

0

106

1

에러가 발생합니다

0

117

1

프론트 에러 뜨는데 수정 안해주시나요

0

166

1

emit() broadcast.emit() 질문있습니다

0

107

1

서버연결이 안됩니다.

1

408

1

[PM2][ERROR] Command not found

0

528

1

S3에 업로드까지는 성공했는데 사진이 나오지 않습니다.

0

254

1

error_code : Property 'user' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.ts(2339)

0

607

1

jwt를 따로 연습하고 있는데 env를 못읽는 것 같습니다.

0

330

2

Ec2로 안하시는 이유가 있을까요?

0

345

1