feat: 스웨거 그룹화 #1138
Merged
feat: 스웨거 그룹화 #1138
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
… feature/1060-swagger-grouping
… feature/1060-swagger-grouping
… feature/1060-swagger-grouping
… feature/1060-swagger-grouping
Soundbar91
requested review from
songsunkook,
Choi-JJunho,
daheeParkk and
20HyeonsuLee
Choi-JJunho
requested changes
Dec 16, 2024
| "in.koreatech.koin.domain.version" | ||
| }); | ||
|
|
||
| private final String[] paths; |
There was a problem hiding this comment.
A
List이 아니라 String[]을 사용한 이유가 있나요?
There was a problem hiding this comment.
GroupOpenApi에서 제공하는 빌더의 모든 파라미터 인자가 String.. 으로 받아서, String[]을 사용했습니다.
지금 확인해보니, GroupOpenApi 내부에서 String[]을 List으로 변환하고 있습니다.
|
|
||
| @Bean | ||
| public GroupedOpenApi adminApi() { | ||
| return createGroupedOpenApi("1. Admin API", ADMIN_API.getPaths()); |
There was a problem hiding this comment.
C
어짜피 문서화의 영역이고 1depth 더 들어가서 확인해야하는 부분이 번거롭게 느껴져서 굳이 Enum으로 구분하지 않아도 될거같은데 어떻게 생각하시나요?
There was a problem hiding this comment.
말씀해주신 것 처럼 문서화의 영역이기 때문에, 변경이 자주 일어나지 않을 것 같다는 생각도 들고 한 번 더 들어가는 부분에서 느껴지는 번거러움도 동의합니다 !
개인적으로는 경로는 다른 곳에서 관리하고, 설정 클래스 코드를 깔끔하게 하고 싶다라는 생각에 Enum을 적용했습니다.
이 생각을 했을 때가 SwaggerConfig 클래스에서 모든 것(그룹화, 기존 설정)을 관리했을 때여서, 지금 두 개의 Config 클래스로 분할한 시점에서 Enum으로 구분하지 않아도 될 것 같다는 생각이 듭니다 !
좋은 의견 감사합니다 🥇
20HyeonsuLee
approved these changes
Dec 20, 2024
duehee
pushed a commit
that referenced
this pull request
Dec 30, 2024
* chore: swagger 패키지 생성 및 클래스 이동 * feat: 비즈니스팀 API 그룹화 * chore: 비즈니스 API 추가 * feat: 캠퍼스팀 API 그룹화 * feat: 유저팀 API 그룹화 * feat: ABTEST API 그룹화 * feat: BCSD API 그룹화 * chore: 비즈니스팀 API 추가 * feat: 어드민 API 그룹화 * chore: 유저팀 API 추가 * feat: 로그인 API 그룹화 및 그룹 이름 변경 * refactor: 패키지 경로 enum화 * refactor: 중복 코드 메소드화 * refactor: 그룹 스웨거 파일 분할 * chore: 미사용 import 삭제 * chore: 메소드 명 변경 * chore: 리뷰 반영
duehee
added a commit
that referenced
this pull request
Dec 30, 2024
* feat : 엑셀 파일 최신화 * feat : 리팩토링 진행 및 패키지 이동 * chore : 안 쓰는 import 제거 및 정리 * chore : 관규님 리뷰 반영 * chore : 개행 추가 * feat: lecture 컬럼 크기 수정 flyway 추가 (#1142) * fix: 식단 이미지 알림 롤백 (#1145) * fix: 스케줄러 cron식 수정 * fix: 식단 이미지 업로드 알림 롤백 * fix : 동계방학 생협 운영시간 업데이트 (#1144) * fix : 생협 동계학기 운영 시간 수정 * fix : 생협 동계학기 운영 시간 수정 * chore : 공백 추가 * fix: 세탁소 전화번호 수정 * feat: 스웨거 그룹화 (#1138) * chore: swagger 패키지 생성 및 클래스 이동 * feat: 비즈니스팀 API 그룹화 * chore: 비즈니스 API 추가 * feat: 캠퍼스팀 API 그룹화 * feat: 유저팀 API 그룹화 * feat: ABTEST API 그룹화 * feat: BCSD API 그룹화 * chore: 비즈니스팀 API 추가 * feat: 어드민 API 그룹화 * chore: 유저팀 API 추가 * feat: 로그인 API 그룹화 및 그룹 이름 변경 * refactor: 패키지 경로 enum화 * refactor: 중복 코드 메소드화 * refactor: 그룹 스웨거 파일 분할 * chore: 미사용 import 삭제 * chore: 메소드 명 변경 * chore: 리뷰 반영 * fix: 안경점, 우편취급국 운영시간 추가, 대즐 운영시간 오타 수정 (#1151) * feat: flyway추가 & model 관련 추가 및 수정 * feat: 시간표 조회 API 이수 구분 반환 추가 (#1150) * feat: repository 추가 * feat: exception 추가 * feat: 이수 구분 반환값 추가 * feat: coursetype 반환값 추가 * test: 테스트 코드 수정 * chore: 리뷰 반영 * fix: department 중복 수정 * fix: department 조회 로직 변경 * rebase : 충돌 해결 * chore : 현수님 리뷰 반영 --------- Co-authored-by: 신관규 <[email protected]> Co-authored-by: 허준기 <[email protected]> Co-authored-by: Hwang HyeonSik <[email protected]> Co-authored-by: 김원경 <[email protected]>
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.
🔥 연관 이슈
🚀 작업 내용
💬 리뷰 중점사항
늦어서 죄송합니다..
관련해서 문서 확인해주시면 감사하겠습니다.
추가로 팀별로 혹시 빠진 API가 있는지 확인해주시면 감사하겠습니다.
빠진 API는 ApiPackage enum에서 패기지 경로를 확인해주시면 됩니다..!