[refactor] #241 - Swagger 문서화 작업 #242
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
hoonyworld
reviewed
Oct 8, 2024
There was a problem hiding this comment.
고생하셨습니다 혜린님!!
전반적으로 swagger 문서 코드와 controller 코드가 잘 분리되어있는 것 같습니다.
다만 어떤 문서는 ApiRespones가 명시되어 있지 않거나, 성공 ApiRespones만 명시되어 있거나, content 옵션이 없거나 등 문서 컨벤션이 통일이 되어 있지 않습니다!!
그래서 다음과 같이 통일성 있게 스웨거 문서를 작성해주시면 감사하겠습니다.
ApiResponses에 value 옵션으로 성공/실패ApiResponses넣기 (해당 api 호출시 발생할 수 있는 예외는 모두 명시하기)- content 옵션 포함시키기
- content 옵션 명시할 때,
@Content(schema = @Schema(implementation = SuccessResponse.class),@Content(schema = @Schema(implementation = ErrorResponse.class)모두 표시하기
Comment on lines
35
to
36
| private final static int COOKIE_MAX_AGE = 7 * 24 * 60 * 60; | ||
| private final static String REFRESH_TOKEN = "refreshToken"; |
There was a problem hiding this comment.
이 부분 final static이 아닌 static final로 컨벤션 통일하는게 좋을 것 같습니다!
hyerinhwang-sailin
temporarily deployed
to
dev
GitHub Actions
Inactive
hoonyworld
approved these changes
Oct 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue 🛠
Work Description ✏️
booking, member, performance, schedule, ticket 관련 api의 swagger 문서화 작업을 진행했습니다.
HealthCheckController의 경우 작업이 단순하고 클라이언트와 상호작용하지 않기에 문서화하지 않았습니다.
Trouble Shooting ⚽️
Related ScreenShot 📷
Uncompleted Tasks 😅
To Reviewers 📢