[SpringBoot3] Springboot 3.X에 Swagger 적용하기

@Last Update
23.02.20
[개발환경]
M2 OSX Ventura 13.0.1
SpringBoot 3.0.2
Gradle

[개발도구]
VS Code

1. springdoc-openapi(Swagger) 적용하기

spring boot프로젝트의 API 문서 생성을 자동으로 생성해 준다. springdoc-openapi는 실행 시 응용 프로그램을 검사해서 spring 구성, 클래스 구조 등 다양한 주석과 어노테이션을 기반으로 API 의미를 추론한다.

가장 많이 사용하는 Springfox Swagger를 사용하였으나 Spring버전이 맞지 않아서 인지 에러와 함께 404에러가 발생했다.

Spring 2 에서는 localhost:8080/swagger-ui.html

Spring 3에서는 localhost:8080/swagger-ui/index.html

위와 같이 변경되었으니 버전별로 경로를 확인한다. 하지만 둘 다 접속이 되지 않았다.

2. 해결

Springdoc(https://springdoc.org/v2/#Introduction)을 사용한다.

가장 상단에 버전을 확인한 다음 종속성(build.gradle > dependencies)에 추가한다.

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