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.

Sign up for GitHub

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

Jump to bottom

[Refactor] Swagger를 사용한 문서화 #125

Closed
zbqmgldjfh opened this issue Jan 23, 2024 · 0 comments · Fixed by #136
Closed

[Refactor] Swagger를 사용한 문서화 #125

zbqmgldjfh opened this issue Jan 23, 2024 · 0 comments · Fixed by #136
Assignees
@zbqmgldjfh
Labels
📄 Documentation Improvements or additions to documentation 🔧 Refactor

Comments

@zbqmgldjfh
Copy link
Member

문제점

기존의 v1 api들의 경우 RestDocs를 사용하여 문서화를 진행하였다.
초기에 나는 Test겸 문서화 까지 가능하며, product코드에 추가적인 사항을 기술하지 않아도 된다는 점에서 당연히 RestDocs를
더 선호하였다.

문제는 다음 2가지 점에서 불편하였다.

  1. 클라이언트 팀이 바로바로 사용해볼수 있는 Swagger를 선호하며, RestDocs의 가독성이 떨어진다 업급해줌
  2. RestDocs의 경우 작성 시간이 걸리기에, 선뜻 문서화 하려는 생각이 들지 않음

위와같은 단점을 통해, Swagger사용으로 변경하기로 하였습니다.
@zbqmgldjfh zbqmgldjfh added 📄 Documentation Improvements or additions to documentation 🔧 Refactor labels Jan 23, 2024
@zbqmgldjfh zbqmgldjfh self-assigned this Jan 23, 2024
zbqmgldjfh added a commit that referenced this issue Feb 12, 2024
@zbqmgldjfh
[Feat] Api docs v2 #125 (#136)
a126209 
* setting: Swagger 의존성 추가

* feat: API 문서화 완료

* setting: Swagger, TestContainer 버전 변경

* setting: SpringBoot version migration from 2.5.5 to 2.7.18

* feat: 문서화에서 제외할 Controller들에게 Hidden 추가

* setting: 사용하지 않는 gradle의 과정 제거
@zbqmgldjfh zbqmgldjfh linked a pull request Feb 12, 2024 that will close this issue
[Feat] Api docs v2 #125 #136
Merged
zbqmgldjfh added a commit that referenced this issue Feb 18, 2024
@zbqmgldjfh
version 2.6.0 (#137)
738fdbe 
* [�Feat] Hexagonal architecture #129 (#131)

* setting(archUnit): 아키텍처 테스팅 의존성 추가

* test(HexagonalArchitecture): User의 HexagonalArchitecture 검증

* refactor: User 도메인 헥사고날 아키텍처로 전환

* feat: 헥사고날 애너테이션 적용

* refactor: API가 포트에 의존하도록 변경

* refactor: UseCase의 구현체들이 Port에 의존하도록 리팩토링

* test: Notice의 HexagonalArchitecture 검증

* refactor: Notice 도메인 헥사고날 아키텍처로 전환

* test: Admin의 HexagonalArchitecture 검증

* refactor(NoticeUpdateSupport): NoticeUpdateSupport 일부 로직 수정

* refactor: Admin 도메인 헥사고날 아키텍처로 전환

* refactor: 필요없는 설정파일 삭제

* test: Staff의 HexagonalArchitecture 검증

* refactor: Staff 도메인 헥사고날 아키텍처로 전환

* feat: User 도메인의 Firebase 로직을 Event로 처리하도록 구현

* feat: User-Token을 preHandler로 검증하도록 변경

* feat(MessageUserEventListener): Token Validation 리스너 제거

* feat(FirebaseService): 비즈니스 로직이 port에 의존하도록 리팩토링

* feat(FirebaseWithAdminUseCase): 어드민의 공지 전송 작업을 이벤트로 구현

* refactor: 기존의 단일 FirebaseService 를 구독과 공지 전송 2개의 서비스로 분리한다

* refactor(DependencyRuleTests): 기존 아키텍처 검증에서 event 페키지 추가 검증하도록 구현

* fix: QueryDsl이 사용하는 dto의 경로 재설정

* chore: 테스트 서식 지정자 제거와 주석 제거

* docs(README): 문서 업데이트

* refactor(ServerProperties): 공통으로 사용중인 서버의 환경변수를 Common 패키지 하부로 이동

* refactor(FirebaseExceptionHandler): exception handler의 페키지를 adapter.out으로 이동

* [Fix] FirebaseSubscribeService의 토큰 검증 로직 변경 (#133)

verifyIdToken의 경우 클라이언트 측에서 별도의 ID 토큰을 생성하여 전달해주어야 하기 때문에 일단 기존의 방식으로 변경한다

* fix(NoticeQueryApiV2#getNotices): 학과공지 조회에서 important필드 결여로 인한 문제 해결 완료 (#135)

* [Feat] Api docs v2 #125 (#136)

* setting: Swagger 의존성 추가

* feat: API 문서화 완료

* setting: Swagger, TestContainer 버전 변경

* setting: SpringBoot version migration from 2.5.5 to 2.7.18

* feat: 문서화에서 제외할 Controller들에게 Hidden 추가

* setting: 사용하지 않는 gradle의 과정 제거
zbqmgldjfh added a commit that referenced this issue Feb 18, 2024
@zbqmgldjfh
[Feat] Api docs v2 #125 (#136)
0def313 
* setting: Swagger 의존성 추가

* feat: API 문서화 완료

* setting: Swagger, TestContainer 버전 변경

* setting: SpringBoot version migration from 2.5.5 to 2.7.18

* feat: 문서화에서 제외할 Controller들에게 Hidden 추가

* setting: 사용하지 않는 gradle의 과정 제거
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zbqmgldjfh zbqmgldjfh

Labels
📄 Documentation Improvements or additions to documentation 🔧 Refactor
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Feat] Api docs v2 #125 ku-ring/ku-ring-backend-web
1 participant
@zbqmgldjfh