Spring Boot2 Swagger 사용

Gradle 설정 추가

 // swagger
implementation 'io.springfox:springfox-swagger2:3.0.0'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'

SwaggerConfig.java

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.ant("/order"))                
                .build();
    }

    public ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("OrderService API")
                .version("0.0.1")
                .description("OrderService API명세서")
                .build();
    }
}

apiInfo는 부가적인 정보로 생략 가능하다.

RequestHandlerSelectors.any()로 하면 RequestMapping으로 할당된 모든 api를 

swgger에서 확인할 수 있다.

paths에서 requestMapping된 api중에 /order 경로로 들어오는 api만 swagger를 적용한다.

 

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

로 들어가면 swagger-ui를 볼 수 있다.

 

swagger-ui 3.x 버전부터는 경로가 바꼈다고 한다.

swagger-ui/index.html