요약: SpringBoot 프로젝트 에서 Swagger 2 사용 하기

1782 단어 SpringBoot 학습
springboot 프로젝트 에서 swagger 2 를 인터페이스 로 문 서 를 보 려 고 합 니 다:
1. 사용 하 는 jar 패키지: pom. xml 파일 에 아래 의존 도 를 도입 합 니 다.


    io.springfox
    springfox-swagger2
    2.8.0


    io.springfox
    springfox-swagger-ui
    2.8.0

2. 시작 클래스 에 아래 주 해 를 추가 하면 링크 를 열 수 있 습 니 다. http://127.0.0.1:8081/swagger-ui.html#/
@EnableSwagger2

3. 단, 앞의 두 단 계 를 거 친 후에 swagger 페이지 에 BaseController 등 불필요 한 정보 가 나타 나 면 코드 에 설정 류 를 써 서 걸 러 낼 수 있 습 니 다.
/**
 *      :
 *     swaggerUI      basic-error-controler  
 * */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select() //        api   document
                .apis(RequestHandlerSelectors.any())//    api    
                //          
                .paths(Predicates.not(PathSelectors.regex("/error.*")))//       
                .paths(PathSelectors.regex("/.*"))//            
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("API    ")
                .license("The Apache License, Version 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
                .version("v1.0")
                .build();
    }
}

위의 3 단 계 를 거 친 후 정상적으로 swagger 페이지 를 사용 하여 인터페이스 정 보 를 볼 수 있 습 니 다 (가능 한 한 swagger 의 주석 과 @ Api 등 을 사용 하 십시오)

좋은 웹페이지 즐겨찾기