[ADD] 스웨거 Response 정보 추가 (제안)

[thguss]

Related issue 🚀

• closed [DOCS] 스웨거 Response 표현 제안 #230

Work Description 💚

• 제안합니다.
• 응답 값(data)을 갖는 API에서, Response 필드 정보를 추가할 수 있습니다. (아래 이미지 참고)
• 다만 성공 응답 값과 다른 형식을 갖는 에러 코드의 응답 값을 별도로 처리하기 위해 ErrorCode라는 별도의 클래스가 필요합니다.
• 이 부분 함께 논의해보면 좋을 것 같아요~
• 아래 이미지는 위 사항 적용했을 때의 스웨거 페이지입니다! (우선 테스트로 일기 상세 조회 API만 적용)

[thguss]

다른 방법으로, 에러 코드는 content=@Content로 처리하고 ErrorCode 파일 없애는 건 어떤가요??
요렇게 하면 아예 비워져서 나오는데, 이렇게 가도 좋을 것 같아요!

[unanchoi]

다른 방법으로, 에러 코드는 content=@Content로 처리하고 ErrorCode 파일 없애는 건 어떤가요?? 요렇게 하면 아예 비워져서 나오는데, 이렇게 가도 좋을 것 같아요!

포포리 할 때, 이런식으로 처리 했었는데 명세서가 훨씬 깔끔해지는 것 같습니다 ~~
클라이언트 분들한테 설명만 충분히 된다고 하면, 이 방법 괜찮을 것 같아요 !

[thguss]

@unanchoi 좋아요!
그럼 클라이언트 오류는 ErrorResponse 파일은 삭제하고 @content로 처리할까요?? 예외 메시지 통일에 노션 명세서도 있어서 괜찮을 것 같아요! (우선 서버 내에서 확정하고, 그렇게 하기로하면 클라이언트한테도 따로 물어보겠습니다~) 추가로, BaseResponse<?>를 BaseResponse로 고쳐서 전체 데이터 필드가 보이게 하는 방식도 괜찮을까요!?

[unanchoi]

@thguss 답장이 늦었네요 ~ 네 좋아요~

추가로, BaseResponse<?>를 BaseResponse로 고쳐서 전체 데이터 필드가 보이게 하는 방식도 괜찮을까요!?

좋습니다 ~ 예시 코드 작성해주시면, 맞춰서 리팩토링 하겠습니다!

[thguss]

@unanchoi
우선 성공 케이스만 클래스 타입 명시하는 예시 하나 작성해뒀습니다~ (일기 상세 조회 API)

또한, 우발적 중복을 주의하기 위해서 BaseResponse를 SuccessResponse와 ErrorResponse로 분리하는 것이 좋을 것 같다는 생각이 드네요!
두 Response로 분리하게 되면 예외 응답도 Swagger에 노출 가능할 것 같습니다.

PR 예시 내용 및 위 사항은 코어타임 중 함께 의논해보면 좋을 것 같아요 :)

[thguss]

• BaseResponse 분리
• ErrorHandler 반영, 일부 API 반영

위 작업 완료했습니다!
윤한 담당 API 반영까지 끝나고 CI 통과하면 머지할게요~

[unanchoi]

수고하셨습니다 ~ 어프로브하겠습니다