Spring Boot 3.x 버전 이후에서 Swagger 사용하는

layl__a·2023년 3월 7일
0

Spring Boot

목록 보기
17/17

Spring Boot 버전 및 테스트 환경

맨 처음 시도

implementation 'io.springfox:springfox-boot-starter:3.0.0'

  • Swagger 3.0.0 에서 부터 2.0과 달라진 점이 많았었는데, springfox-boot-starter:3.0.0 을 사용해도 된다는 점이 그 중 하나다.

dependencies {
implementation 'io.springfox:springfox-boot-starter:3.0.0'
}

  • 또한 2.x 버전에서는 localhost:8080/swagger-ui.html로 접속해야했지만 3.x 버전부터는 localhost:8080/swagger-ui/index.html 로 접속해야 정상적으로 페이지가 나온다.

-> 하지만 Spring boot 3.x 버전에서는 실패

  • SwaggerConfig도 작성해보았지만 똑같이 Whitelabel Error가 뜬다.

springdoc-openapi-starter-webmvc-ui 사용

Spring boot 3.x 부터는 Springfox대신 Springdoc를 사용해야한다.

공식문서: https://springdoc.org

dependencies {
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
}

  • Springdoc은 따로 SwaggerConfig를 넣지 않아도 된다.

localhost:8080/swagger-ui/index.html 접속 성공

공식 문서: https://springdoc.org/v2/

0개의 댓글