[refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc #75

Gopistol · 2023-12-20T13:49:14Z

해당 PR이 어떤 것을 하나요?

OAS 3.0 을 지원하는 Springdoc를 사용하여 기존의 Swagger UI를 지원하는 라이브러리를 변경함

고민(선택)

Swagger UI로 매핑되는 URL을 http://localhost:8080/swagger-new-ui.html 로 매핑되도록 설정하려고 했으나, 설정 파일에서의 path를 수정해도 404 페이지가 계속 뜨는 이슈가 발생하여 기존의 http://localhost:8080/swagger-ui.html 로 매핑되도록 함.

기획 문서 혹은 태스크 관련 링크

http://localhost:8080/swagger-ui.html

codecov · 2023-12-20T13:55:03Z

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (b075bfe) 92.70% compared to head (4fc657c) 92.75%.

Additional details and impacted files

@@             Coverage Diff              @@
##               main      #75      +/-   ##
============================================
+ Coverage     92.70%   92.75%   +0.05%     
- Complexity      367      369       +2     
============================================
  Files            72       72              
  Lines           781      842      +61     
  Branches         23       23              
============================================
+ Hits            724      781      +57     
- Misses           43       47       +4     
  Partials         14       14

Files	Coverage Δ
...in/com/mjucow/eatda/common/config/SwaggerConfig.kt	`100.00% <100.00%> (ø)`
...n/kotlin/com/mjucow/eatda/common/vo/PhoneNumber.kt	`100.00% <ø> (ø)`
...rc/main/kotlin/com/mjucow/eatda/common/vo/Point.kt	`100.00% <100.00%> (ø)`
.../banner/service/command/dto/CreateBannerCommand.kt	`87.50% <100.00%> (+7.50%)`	⬆️
.../banner/service/command/dto/UpdateBannerCommand.kt	`100.00% <100.00%> (ø)`
...eatda/domain/banner/service/query/dto/BannerDto.kt	`100.00% <100.00%> (ø)`
.../notice/service/command/dto/UpdateNoticeCommand.kt	`100.00% <100.00%> (ø)`
...eatda/domain/notice/service/query/dto/NoticeDto.kt	`100.00% <100.00%> (ø)`
.../domain/store/service/command/dto/CreateCommand.kt	`100.00% <100.00%> (ø)`
...ain/store/service/command/dto/MenuCreateCommand.kt	`100.00% <100.00%> (ø)`
... and 14 more

dojinyou · 2023-12-20T14:45:22Z

ktlint-check 통과를 못할 때 ktlintFormat gradle task 실행하기

./gradlew ktlintFormat

src/main/kotlin/com/mjucow/eatda/presentation/common/example/StoreDtosApiResponse.kt

src/main/kotlin/com/mjucow/eatda/presentation/notice/NoticeController.kt

src/main/resources/static/swagger-ui/openapi3.yaml

dojinyou · 2023-12-21T07:30:10Z

src/main/kotlin/com/mjucow/eatda/presentation/store/StoreController.kt

        @RequestParam("storeId", required = false) storeId: Long?,
        @RequestParam("categoryId", required = false) categoryId: Long?,
-        @RequestParam("size", required = false) pageSize: Int = 20,


default값 잘 들어가는지 체크해보기

하위 클래스에선 매개변수의 default value를 정의할 수 없다는 규칙이 있다고해서 저 pageSize라는 변수를 companion object로 분리하는 방안은 어떤가요..?

interface에서 default value가 들어간 것 같아서 동작 체크만 해보면 될 것 같아요!

src/main/kotlin/com/mjucow/eatda/presentation/store/Store.kt

build.gradle.kts

src/main/resources/application.yml

Co-authored-by: 유도진 <[email protected]>

dojinyou · 2023-12-21T08:19:07Z

작업 끝난 뒤에 주석된 코드들은 지워주세요!

dojinyou · 2023-12-22T05:58:43Z

PR에 정상적으로 swagger가 생성된 모습 캡쳐해서 올려주면 좋을 것 같아요!

build.gradle.kts

src/main/kotlin/com/mjucow/eatda/common/config/SwaggerConfig.kt

src/main/kotlin/com/mjucow/eatda/domain/banner/service/query/dto/BannerDto.kt

src/main/kotlin/com/mjucow/eatda/domain/poplarstore/service/dto/PopularStoreDto.kt

src/main/kotlin/com/mjucow/eatda/domain/store/service/command/dto/UpdateNameCommand.kt

src/main/kotlin/com/mjucow/eatda/domain/store/service/query/dto/StoreDetailDto.kt

src/main/kotlin/com/mjucow/eatda/presentation/common/example/StoreDtosApiResponse.kt

src/main/kotlin/com/mjucow/eatda/presentation/store/StoreApiPresentation.kt

src/main/resources/application.yml

dojinyou

기본값만 체크하고 merge 하시죵

* [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml Co-authored-by: 유도진 <[email protected]> * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- Co-authored-by: 유도진 <[email protected]> * [etc] version 수정 (#77) --------- Co-authored-by: 유도진 <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]>

* [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml Co-authored-by: 유도진 <[email protected]> * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- Co-authored-by: 유도진 <[email protected]> * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) --------- Co-authored-by: 유도진 <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]>

* [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml Co-authored-by: 유도진 <[email protected]> * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- Co-authored-by: 유도진 <[email protected]> * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) * swagger 수정 (#83) * [fix] redis 분리 및 api 추가 (#85) --------- Co-authored-by: Bokyeom <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> Co-authored-by: k-kbk <[email protected]>

* v0.1.8-Release (#82) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml Co-authored-by: 유도진 <[email protected]> * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- Co-authored-by: 유도진 <[email protected]> * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) --------- Co-authored-by: 유도진 <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> * V0.1.9 (#86) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml Co-authored-by: 유도진 <[email protected]> * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- Co-authored-by: 유도진 <[email protected]> * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) * swagger 수정 (#83) * [fix] redis 분리 및 api 추가 (#85) --------- Co-authored-by: Bokyeom <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> Co-authored-by: k-kbk <[email protected]> --------- Co-authored-by: Bokyeom <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> Co-authored-by: k-kbk <[email protected]>

* v0.1.8-Release (#82) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) --------- * V0.1.9 (#86) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) * swagger 수정 (#83) * [fix] redis 분리 및 api 추가 (#85) --------- --------- Co-authored-by: Bokyeom <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> Co-authored-by: k-kbk <[email protected]>

* v0.1.8-Release (#82) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml Co-authored-by: 유도진 <[email protected]> * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- Co-authored-by: 유도진 <[email protected]> * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) --------- Co-authored-by: 유도진 <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> * V0.1.9 (#86) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml Co-authored-by: 유도진 <[email protected]> * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- Co-authored-by: 유도진 <[email protected]> * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) * swagger 수정 (#83) * [fix] redis 분리 및 api 추가 (#85) --------- Co-authored-by: Bokyeom <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> Co-authored-by: k-kbk <[email protected]> * v.0.1.10 (#92) * v0.1.8-Release (#82) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) --------- * V0.1.9 (#86) * [etc] logger 추가 및 Exception logging 추가 (#71) * [etc] CODEOWNERS 수정 (#72) * Spring boot version 3.1.2 -> 3.1.6 (#73) * [refactor]cursor 기반 page 타입 변경 (#74) * [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc (#75) * Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc * 컨트롤러 인터페이스 분리 * Update src/main/resources/static/swagger-ui/openapi3.yaml * build.gradle 의존성 제거 * 인터페이스 이름 변경: ApiPresentation 추가 * 커버리지 체크 제외할 리스트 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix 수정 * postfix수정 * REST doc 관련 의존성 및 파일 삭제 * 변경 사항 반영 * 리뷰 반영해서 수정 * 초깃값 동작 체크 --------- * [etc] version 수정 (#77) * [etc] storeId → cursor 수정 (#79) * [etc] version 수정 (#80) * swagger 수정 (#83) * [fix] redis 분리 및 api 추가 (#85) --------- --------- Co-authored-by: Bokyeom <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> Co-authored-by: k-kbk <[email protected]> * v0.1.11 (#94) --------- Co-authored-by: Bokyeom <[email protected]> Co-authored-by: YOON <[email protected]> Co-authored-by: Gopistol <[email protected]> Co-authored-by: k-kbk <[email protected]>

Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc

738c8b6

Gopistol self-assigned this Dec 20, 2023

Gopistol requested review from dojinyou, k-kbk and 0702Yoon as code owners December 20, 2023 13:49

pull-request-size bot added the size/L label Dec 20, 2023

github-actions bot added the refactor 코드 개선 label Dec 20, 2023

dojinyou reviewed Dec 20, 2023

View reviewed changes

Gopistol changed the title ~~[refactor] Swagger UI 라이브러리 변경 - Spring REST docs -> Springdoc~~ [refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc Dec 20, 2023

컨트롤러 인터페이스 분리

aea57fe

pull-request-size bot added size/XL and removed size/L labels Dec 21, 2023

dojinyou reviewed Dec 21, 2023

View reviewed changes

Update src/main/resources/static/swagger-ui/openapi3.yaml

61060c4

Co-authored-by: 유도진 <[email protected]>

pull-request-size bot added size/L and removed size/XL labels Dec 21, 2023

build.gradle 의존성 제거

e471a1d

pull-request-size bot added size/XL and removed size/L labels Dec 21, 2023

Gopistol added 3 commits December 21, 2023 16:53

인터페이스 이름 변경: ApiPresentation 추가

6e379e6

커버리지 체크 제외할 리스트 수정

f08fe91

postfix 수정

4482a8a

Gopistol added 5 commits December 21, 2023 17:20

postfix 수정

3d93d53

postfix 수정

7f2ae10

postfix 수정

5be6ae3

postfix수정

fe49808

REST doc 관련 의존성 및 파일 삭제

acb19ea

pull-request-size bot added size/XXL and removed size/XL labels Dec 21, 2023

Gopistol requested a review from dojinyou December 23, 2023 06:52

dojinyou reviewed Dec 23, 2023

View reviewed changes

변경 사항 반영

44e3a22

Gopistol requested a review from dojinyou January 3, 2024 13:38

dojinyou reviewed Jan 3, 2024

View reviewed changes

리뷰 반영해서 수정

8890c08

Gopistol requested a review from dojinyou January 3, 2024 15:03

dojinyou approved these changes Jan 3, 2024

View reviewed changes

초깃값 동작 체크

4fc657c

Gopistol merged commit 80b9db1 into main Jan 4, 2024
5 checks passed

Gopistol deleted the swagger branch January 4, 2024 03:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc #75

[refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc #75

Gopistol commented Dec 20, 2023 •

edited

Loading

codecov bot commented Dec 20, 2023 •

edited

Loading

dojinyou commented Dec 20, 2023

dojinyou Dec 21, 2023 •

edited

Loading

Gopistol Dec 21, 2023

dojinyou Dec 21, 2023

dojinyou commented Dec 21, 2023

dojinyou commented Dec 22, 2023

dojinyou left a comment

[refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc #75

[refactor] Swagger UI 라이브러리 변경: Spring REST docs -> Springdoc #75

Conversation

Gopistol commented Dec 20, 2023 • edited Loading

해당 PR이 어떤 것을 하나요?

고민(선택)

기획 문서 혹은 태스크 관련 링크

codecov bot commented Dec 20, 2023 • edited Loading

Codecov Report

dojinyou commented Dec 20, 2023

dojinyou Dec 21, 2023 • edited Loading

Choose a reason for hiding this comment

Gopistol Dec 21, 2023

Choose a reason for hiding this comment

dojinyou Dec 21, 2023

Choose a reason for hiding this comment

dojinyou commented Dec 21, 2023

dojinyou commented Dec 22, 2023

dojinyou left a comment

Choose a reason for hiding this comment

Gopistol commented Dec 20, 2023 •

edited

Loading

codecov bot commented Dec 20, 2023 •

edited

Loading

dojinyou Dec 21, 2023 •

edited

Loading