Java之Swagger配置掃描接口以及開關(guān)案例講解

更新時(shí)間：2021年08月05日 10:53:45 作者：Z && Y

這篇文章主要介紹了Java之Swagger配置掃描接口以及開關(guān)案例講解,本篇文章通過簡(jiǎn)要的案例,講解了該項(xiàng)技術(shù)的了解與使用,以下就是詳細(xì)內(nèi)容,需要的朋友可以參考下

1. Swagger--配置掃描接口及開關(guān)

1.1 配置掃描接口

在這里插入圖片描述

SwaggerConfig.java

    /**
     * 配置docket以配置Swagger具體參數(shù)
     */
    @Bean
    public Docket docket() {
        /*
         * 通過.select()方法，去配置掃描接口,RequestHandlerSelectors配置如何掃描接口
         * basePackage(final String basePackage) // 根據(jù)包路徑掃描接口（最常用）
         * any() 掃描所有，項(xiàng)目中的所有接口都會(huì)被掃描到
         * none() 不掃描接口
         * 通過方法上的注解掃描，如withMethodAnnotation(GetMapping.class)只掃描get請(qǐng)求
         * withMethodAnnotation(final Class<? extends Annotation> annotation)
         * 通過類上的注解掃描，如.withClassAnnotation(Controller.class)只掃描有controller注解的類中的接口
         * withClassAnnotation(final Class<? extends Annotation> annotation)
         */
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).build();
    }

運(yùn)行結(jié)果（因?yàn)楝F(xiàn)在只掃描了com.tian.swagger.controller 的包所以只會(huì)有一個(gè)HelloController）：

在這里插入圖片描述

1.2 配置接口掃描過濾

在這里插入圖片描述

SwaggerConfig.java

    /**
     * 配置docket以配置Swagger具體參數(shù)
     */
    @Bean
    public Docket docket() {
        /*
         * 通過.select()方法，去配置掃描接口,RequestHandlerSelectors配置如何掃描接口
         * basePackage(final String basePackage) // 根據(jù)包路徑掃描接口
         * any() 掃描所有，項(xiàng)目中的所有接口都會(huì)被掃描到
         * none() 不掃描接口
         * 通過方法上的注解掃描，如withMethodAnnotation(GetMapping.class)只掃描get請(qǐng)求
         * withMethodAnnotation(final Class<? extends Annotation> annotation)
         * 通過類上的注解掃描，如.withClassAnnotation(Controller.class)只掃描有controller注解的類中的接口
         * withClassAnnotation(final Class<? extends Annotation> annotation)
         */
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).paths(PathSelectors.ant("/tian/**")).build();
    }

這里只選擇了請(qǐng)求路徑包含了/tian下的所有接口

這里可以選擇的參數(shù)有：

any() // 任何請(qǐng)求都掃描
none() // 任何請(qǐng)求都不掃描
regex(final String pathRegex) // 通過正則表達(dá)式控制
ant(final String antPattern) // 通過ant()控制

1.3 配置Swagger開關(guān)

enable(boolean) 表示是否啟用Swagger 默認(rèn)為true(啟用) 如果為false,則Swagger不能在游覽器中訪問

在這里插入圖片描述

SwaggerConfig.java

    /**
     * 配置docket以配置Swagger具體參數(shù)
     */
    @Bean
    public Docket docket() {
        // enable(boolean) 表示是否啟用Swagger 默認(rèn)為true(啟用) 如果為false,則Swagger不能在游覽器中訪問
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(false).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).paths(PathSelectors.ant("/tian/**")).build();
    }

運(yùn)行結(jié)果：

在這里插入圖片描述

1.4 我只希望我的Swagger在生產(chǎn)環(huán)境中使用，在發(fā)布的時(shí)候不使用。怎么實(shí)現(xiàn)？

判斷是不是生產(chǎn)環(huán)境，是則 flag = false，否則 flag = true
注入enable（flag）

1.4.1 準(zhǔn)備工作，新建2個(gè)配置文件

在這里插入圖片描述

application.properties

spring.profiles.active=dev

application-dev.properties

server.port=8081

application-pro.properties

server.port=8082

1.4.2 代碼實(shí)現(xiàn)

在這里插入圖片描述

SwaggerConfig.java

    /**
     * 配置docket以配置Swagger具體參數(shù)
     */
    @Bean
    // org.springframework.core.env.Environment
    public Docket docket(Environment environment) {
        // 設(shè)置要顯示swagger的環(huán)境 這里是 dev 和 test 環(huán)境
        // org.springframework.core.env.Profiles
        Profiles profiles = Profiles.of("dev", "test");
        // 判斷當(dāng)前是否處于該環(huán)境
        // 通過 enable() 接收此參數(shù)判斷是否要顯示
        boolean flag = environment.acceptsProfiles(profiles);


        // enable(boolean) 表示是否啟用Swagger 默認(rèn)為true(啟用) 如果為false,則Swagger不能在游覽器中訪問
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).enable(flag).select().apis(RequestHandlerSelectors.basePackage("com.tian.swagger.controller")).paths(PathSelectors.ant("/tian/**")).build();
    }

啟動(dòng)測(cè)試01：Profiles 里面包含 dev

在這里插入圖片描述

啟動(dòng)測(cè)試01：Profiles 里面不包含 dev

Profiles profiles = Profiles.of("test");

在這里插入圖片描述

到此這篇關(guān)于Java之Swagger配置掃描接口以及開關(guān)案例講解的文章就介紹到這了,更多相關(guān)Java之Swagger配置掃描接口以及開關(guān)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: