Swagger UI를 SpringBoot 연결하기

아래 설명은 SpringBoot 2.6.7버전 및 Swagger 3.0.0버전으로 최신 버전을 다루고 있습니다.

2.X 버전의 내용도 첨부하였습니다.

1. build.gradle 파일에 dependencies부분에 아래 내용을 추가해준다.

dependencies {
...
	//https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui
	implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

}

반응형

2. 스웨거 UI를 불러오기 위한 Config파일 생성

SwaggerConfig.java 파일을 베이스 패키지에 생성해준다.

@Configuration
@EnableWebMvc
public class SwaggerConfig {

    @Bean
    public Docket swaggerAPI(){
        //Docket : swagger Bean
        return new Docket(DocumentationType.OAS_30)
                .useDefaultResponseMessages(true) //기본 응답 메시지 표시 여부
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.soma13.pokemonsticker")) //swagger탐색 대상 패키지
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Batch Swagger")
                .description("batch execute swagger")
                .version("1.0")
                .build();
    }

}

* config 파일에서 swagger 2.0과 3.0의 차이

@EnableWebMvc : swagger 3.0 버전

@EnableSwagger2 : swagger 2.0 버전

 return new Docket(DocumentationType.OAS_30) //3.0
 
 return new Docket(DocumentationType.SWAGGER_2) //2.0

 

3. 아래 링크에 접속한다.

http://localhost:8080/swagger-ui/

(2.0버전은 localhost:port/swagger-ui.html 로 접속)

기본 설정된 포트번호로 들어가는가서 /swagger-ui/ 로 들어가는것임.

아래와 같이 잘 뜬다.