seecoder-devcloud/web/src/main/java/seecoder/devcloud/web/infrastructure/config/SwaggerConfig.java

package seecoder.devcloud.web.infrastructure.config;


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author PuHong Weng
 * @date 2021/2/3
 * @description:
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig{


    private ApiInfo initApiInfo() {
        return new ApiInfoBuilder()
                .title("seecoder devcloud项目 Platform API")//大标题
                .description(initContextInfo())//简单的描述
                .version("0.0.1")//版本
                .build();
    }

    private String initContextInfo() {
        StringBuffer sb = new StringBuffer();
        sb.append("Devclound API");
        return sb.toString();
    }


    @Bean
    public Docket restfulApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(initApiInfo())
                .select()
                //.paths(doFilteringRules())
                //不显示错误的接口地址
                .apis(RequestHandlerSelectors.basePackage("seecoder.devcloud.web.controller"))
                //.paths(Predicates.not(PathSelectors.regex("/error.*")))
                .paths(PathSelectors.any())
                .build();

    }

    /**
     * 有些重要api可能不想在swagger网页里展示，在这里可以过滤
     * 设置过滤规则
     * 这里的过滤规则支持正则匹配
     * @return
     */
//    private Predicate<String> doFilteringRules() {
//        return or(
//                regex("/hello.*"),
//                regex("/vehicles.*")
//        );
//    }

}