SpringBoot中Swagger2多包掃描問題

API接口類不肯能都放在同一個包下,所以涉及多包掃描的問題,貼出來解決辦法

Swagger在POM配置好後,修改SwaggerConfig類,我只貼出要修改的,直接用

/**注意導入包是否齊全**/
import com.google.common.base.Optional;
import com.google.common.base.Predicate;
import com.google.common.base.Function;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.RequestHandler;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2的接口配置
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig
{

    // 定義分隔符,配置Swagger多包
    private static final String splitor = ";";

    /**
     * 創建API
     */
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                // 詳細定製
                .apiInfo(apiInfo())
                .select()
                // 指定當前包路徑,這裏就添加了兩個包,注意方法變成了basePackage,中間加上成員變量splitor
                .apis(basePackage("com.XX.api.controller.broad"+splitor+"com.XX.api.controller.village"))
                // 掃描所有 .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 添加摘要信息
     * 這裏是接口的描述配置,不重要
     */
    private ApiInfo apiInfo()
    {
        // 用ApiInfoBuilder進行定製
        return new ApiInfoBuilder()
                .title("XXX系統_接口文檔")
                .description("用於XXX統開發組生成RESTapi風格的接口...")
//                .contact(new Contact(Global.getName(), null, null))
//                .version("版本號:" + Global.getVersion())
                .build();
    }


    /**
        * 重寫basePackage方法,使能夠實現多包訪問,複製貼上去
        * @author  teavamc
        * @date 2019/1/26
        * @param [basePackage]
        * @return com.google.common.base.Predicate<springfox.documentation.RequestHandler>
        */
    public static Predicate<RequestHandler> basePackage(final String basePackage) {
        return input -> declaringClass(input).transform(handlerPackage(basePackage)).or(true);
    }

    private static Function<Class<?>, Boolean> handlerPackage(final String basePackage)     {
        return input -> {
            // 循環判斷匹配
            for (String strPackage : basePackage.split(splitor)) {
                boolean isMatch = input.getPackage().getName().startsWith(strPackage);
                if (isMatch) {
                    return true;
                }
            }
            return false;
        };
    }

    private static Optional<? extends Class<?>> declaringClass(RequestHandler input) {
        return Optional.fromNullable(input.declaringClass());
    }
}

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章