Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[fix] #272 - 스웨거에서 ResponseDTO가 잡히지 않는 문제 해결 #273

Merged
merged 2 commits into from
Dec 2, 2024

Conversation

hoonyworld
Copy link
Member

Related issue 🛠

Work Description ✏️

  • SuccessResponse와 같은 구조를 사용할 때, Swagger가 내부 HomeFindAllResponse 타입을 인식하지 못하고 SuccessResponse만 인식하는 문제가 발생했습니다.
  • @content 애노테이션을 삭제하면, Swagger가 자동으로 ResponseEntity<SuccessResponse> 의 반환 타입을 분석하여 SuccessResponse 내부의 제네릭 타입인 HomeFindAllResponse까지 포함하여 문서화하는 것을 확인했습니다.

Trouble Shooting ⚽️

Related ScreenShot 📷

AS-IS

image image
  • requestDTO만 스웨거에 schema로 인식되고 responseDTO가 인식이 되지 않았습니다.

TO-BE

image image
  • requestDTO와 responseDTO 모두 스웨거에 schema로 인식이 되게 되었습니다.

Uncompleted Tasks 😅

To Reviewers 📢

Copy link
Collaborator

@hyerinhwang-sailin hyerinhwang-sailin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

해결하시느라 고생많으셨습니다 👍 👍

@hoonyworld hoonyworld merged commit 8a1289c into develop Dec 2, 2024
1 check passed
@hoonyworld hoonyworld deleted the bug/#272 branch January 13, 2025 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bug] ResponseDTO가 Swagger Schema에서 잡히지 않는 문제
2 participants