Spring Boot 3.X 에 Swagger3를 추가하기

스프링 프로젝트에 의존성을 추가해준다.

 

Maven

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.1.0</version>
   </dependency>

Gradle

// https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui
implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.1.0'

Swagger Configuration을 위한 클래스를 만들어준다.

@Configuration
public class SwaggerConfig {
    @Bean
    public OpenAPI springOpenAPI() {
        return new OpenAPI()
                .info(new Info().title("Spring Boot API")
                        .description("Spring Boot API입니다.")
                        .version("v0.0.1"));
    }
}

Swagger 2 Configuration과 다른 부분이 있으니 참고에 있는 문서를 꼭 확인하자

(Springfox에서의 마이그레이션 부분)

 

의존성 추가와 스웨거 설정이 끝났다면 http://서버:포트/context-path/swagger-ui.html URL에서 Swagger UI 페이지를 확인할 수 있다. (context-path를 따로 설정하지 않았다면, 무시해도 좋다.)

 

⚠️ 참고: Springdoc: getting started https://springdoc.org/#getting-started