[Trouble Shooting] Swagger-ui를 접속했을 때 404 error가 나는 경우

 

이전 프로젝트에서 Swagger를 사용해 같은 설정으로 Swagger를 Config 했으나, 로컬에서 해당 URL로 접속했을 때 404 Error가 나오는 현상을 발견했다.

 

 

 

문제의 원인은 달라진 스프링 부트의 버전으로, 이전에는 2버전을 사용했다면 지금은 3버전을 선택했기 때문에 발생한 오류다.

해결책을 찾은곳은 Stack Overflow였다.

https://stackoverflow.com/questions/74614369/how-to-run-swagger-3-on-spring-boot-3

How to run Swagger 3 on Spring Boot 3

 

결론적인 해결책은, 다른 dependency를 사용해야 한다는 것이었다.

기존에 사용하던 것은 'org.springdoc:springdoc-openapi-ui' 였지만, 'org.springdoc:springdoc-openapi-starter-webmvc-ui'로 변경이 되었다.

 

아래와 같이 build.gradle 파일을 변경했다. 

// 변경 전
implementation 'org.springdoc:springdoc-openapi-ui:1.6.15'

// 변경 후
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'

 

이와 같은 해결 방법으로 정상적으로 Swagger UI를 띄울 수 있게 되었다.

이전에 사용하던 Swagger와 다르게 @Tag와 @Operation을 붙이지 않아도 컨트롤러와 method를 자동인식해 보여주는 것 같았다.

자세한 설명을 위해서는 값을 조정하는 것이 필요하지만, 그래도 Default로 띄워주니 발전했다는 생각이 든다.