[SPRINGBOOT, SWAGGER] SpringBoot 2.7* 버전에 Swagger 3.* 버전 연결하기

[SPRINGBOOT] SpringBoot 2.7* 버전에 Swagger 3.* 버전 연결하기

- 사용한 SpringBoot 버전은 '2.7.18-SNAPSHOT'

1. build.gradle

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

 

- 스웨거 버전을 설정하여 설치해준다.

- 2.X 버전과는 다르게, 하나의 종속성만 추가해 주어도 된다.

 

2. Swagger Config 파일 추가

@Configuration
public class SwaggerConfig {
    private final String TITLE = "title";
    private final String DESCRIPTION = "description";
    private final String VERSION = "V1.0.0";

    @Bean
    public OpenAPI api() {
        return new OpenAPI()
                .info(new Info()
                        .title(TITLE)
                        .description(DESCRIPTION)
                        .version(VERSION)
                );
    }

}

 

- @Bean 어노테이션은 해당 메소드가 스프링 컨테이너에 빈(Bean)을 추가하도록 지시한다. 이 코드에서는 api() 메소드가 OpenAPI 객체를 생성하여 빈으로 등록한다.

- api() 메서드는 Swagger 문서를 위한 OpenAPI 객체를 생성하고 반환한다. 

 

728x90

3. application.yml 파일에 내용 추가

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

 

- 이 코드를 작성해 주지 않았더니, org.springframework.context.ApplicationContextException:  Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException 오류가 발생했다. 

 

4. 접속해서 확인해보기

Swagger 2.X 버전은 localhost:8080/swagger-ui.html이였지만,

Swagger 3.0.0 부터는  localhost:8080/swagger-ui/index.html 로 주소가 바뀌었다.

localhost에 접속해서 스웨거가 잘 작동하는 것을 확인할 수 있다.