Java之Swagger配置掃描接口以及開關(guān)案例講解
更新時間：2021年08月05日 10:53:45 作者：Z && Y
這篇文章主要介紹了Java之Swagger配置掃描接口以及開關(guān)案例講解,本篇文章通過簡要的案例,講解了該項技術(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() 掃描所有，項目中的所有接口都會被掃描到
* none() 不掃描接口
* 通過方法上的注解掃描，如withMethodAnnotation(GetMapping.class)只掃描get請求
* 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();
}
運行結(jié)果（因為現(xiàn)在只掃描了com.tian.swagger.controller 的包 所以只會有一個HelloController）：
1.2 配置接口掃描過濾
SwaggerConfig.java
/**
* 配置docket以配置Swagger具體參數(shù)
*/
@Bean
public Docket docket() {
/*
* 通過.select()方法，去配置掃描接口,RequestHandlerSelectors配置如何掃描接口
* basePackage(final String basePackage) // 根據(jù)包路徑掃描接口
* any() 掃描所有，項目中的所有接口都會被掃描到
* none() 不掃描接口
* 通過方法上的注解掃描，如withMethodAnnotation(GetMapping.class)只掃描get請求
* 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();
}
這里只選擇了請求路徑包含了/tian下的所有接口
這里可以選擇的參數(shù)有：
- any() // 任何請求都掃描
- none() // 任何請求都不掃描
- 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();
}
運行結(jié)果：
1.4 我只希望我的Swagger在生產(chǎn)環(huán)境中使用，在發(fā)布的時候不使用。怎么實現(xiàn)？
- 判斷是不是生產(chǎn)環(huán)境，是則 flag = false，否則 flag = true
- 注入enable（flag）
1.4.1 準(zhǔn)備工作，新建2個配置文件
application.properties
spring.profiles.active=dev
application-dev.properties
server.port=8081
application-pro.properties
server.port=8082
1.4.2 代碼實現(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();
}
啟動測試01：Profiles 里面包含 dev
啟動測試01：Profiles 里面不包含 dev
Profiles profiles = Profiles.of("test");
到此這篇關(guān)于Java之Swagger配置掃描接口以及開關(guān)案例講解的文章就介紹到這了,更多相關(guān)Java之Swagger配置掃描接口以及開關(guān)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
下面小編就為大家?guī)硪黄狫ava反射之通過反射獲取一個對象的方法信息(實例代碼)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-10-10
關(guān)于java開發(fā)的性能問題總結(jié)(必看)
下面小編就為大家?guī)硪黄P(guān)于java開發(fā)的性能問題總結(jié)(必看)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-03-03
下面小編就為大家分享一篇Java解析word,獲取文檔中圖片位置的方法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-01-01
這篇文章主要介紹了Java定義泛型接口和類的方法,結(jié)合實例形式分析了泛型相關(guān)概念、原理及泛型接口與類的定義實現(xiàn)方法,需要的朋友可以參考下2019-08-08
為什么 Java 8 中不需要 StringBuilder 拼接字符串
java8中，編輯器對“+”進行了優(yōu)化，默認(rèn)使用StringBuilder進行拼接，所以不用顯示的使用StringBuilder了，直接用“+”就可以了。下面我們來詳細(xì)了解一下2019-05-05
idea很多地方都設(shè)置了jdk版本,不同模塊的jdk版本也可能不一樣,下面這篇文章主要給大家介紹了關(guān)于idea更改項目(模塊)JDK版本的操作步驟,文中通過圖文介紹的非常詳細(xì),需要的朋友可以參考下2023-11-11
本文主要介紹了SpringMVC異常處理的三種方式小結(jié),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-09-09
這篇文章主要介紹了Spark?實現(xiàn)自定義加密的示例代碼,代碼簡單易懂,對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友參考下吧2024-07-07
SpringBoot線程池ThreadPoolTaskExecutor異步處理百萬級數(shù)據(jù)
本文主要介紹了SpringBoot線程池ThreadPoolTaskExecutor異步處理百萬級數(shù)據(jù),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-03-03
根據(jù)當(dāng)前用戶本地IP地址,查詢IP地址庫,獲取IP所在的省市信息,目前有多種方式實現(xiàn)該功能,這篇文章主要給大家介紹了關(guān)于java如何根據(jù)用戶請求獲取ip地址并解析省市信息的相關(guān)資料,需要的朋友可以參考下2023-12-12