Java之Swagger配置掃描接口以及開關(guān)案例講解
更新時(shí)間：2021年08月05日 10:53:45 作者：Z && Y
這篇文章主要介紹了Java之Swagger配置掃描接口以及開關(guā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請求
* 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請求
* 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();
}
運(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)測試01：Profiles 里面包含 dev
啟動(dòng)測試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ān)于JAVA 中使用Preferences讀寫注冊表時(shí)要注意的地方
這篇文章介紹了關(guān)于JAVA 中使用Preferences讀寫注冊表時(shí)要注意的地方，有需要的朋友可以參考一下2013-08-08
Java讀取一行空格隔開的數(shù)字字符串并求出這些數(shù)字的和方法
今天小編就為大家分享一篇Java讀取一行空格隔開的數(shù)字字符串并求出這些數(shù)字的和方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-07-07
Xml中使用foreach遍歷對(duì)象實(shí)現(xiàn)代碼
這篇文章主要介紹了Xml中使用foreach遍歷對(duì)象實(shí)現(xiàn)代碼,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-12-12
為什么說亂碼是中國程序員無法避免的話題呢？這個(gè)主要是編碼機(jī)制上的原因，大家都知道中文和英文的編碼格式不一樣，解碼自然也不一樣！這篇文章就給大家分享了Java中URL傳中文時(shí)亂碼的解決方法，有需要的朋友們可以參考借鑒。2016-10-10
這篇文章主要介紹了SpringBoot攔截器讀取流后不能再讀取的問題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-10-10
Java?Stream對(duì)象并行處理方法parallel()代碼示例
在Java中Stream是一種用于處理集合數(shù)據(jù)的流式操作API,它提供了一種簡潔、靈活、高效的方式來對(duì)集合進(jìn)行各種操作,下面這篇文章主要給大家介紹了關(guān)于Java?Stream對(duì)象并行處理方法parallel()的相關(guān)資料,需要的朋友可以參考下2023-11-11
有這樣一個(gè)需求，需要將原本存儲(chǔ)在數(shù)據(jù)庫中的文檔轉(zhuǎn)存至文件系統(tǒng)中，于是寫了一個(gè)簡單的程序完成此功能2012-11-11
Java基礎(chǔ)知識(shí)精通二維數(shù)組的應(yīng)用
為了方便組織各種信息，計(jì)算機(jī)常將信息以表的形式進(jìn)行組織，然后再以行和列的形式呈現(xiàn)出來。二維數(shù)組的結(jié)構(gòu)決定了其能非常方便地表示計(jì)算機(jī)中的表，以第一個(gè)下標(biāo)表示元素所在的行，第二個(gè)下標(biāo)表示元素所在的列。下面簡單了解一下二維數(shù)組，包括數(shù)組的聲明和初始化2022-04-04
ArrayList及HashMap的擴(kuò)容規(guī)則講解
今天小編就為大家分享一篇關(guān)于ArrayList及HashMap的擴(kuò)容規(guī)則講解，小編覺得內(nèi)容挺不錯(cuò)的，現(xiàn)在分享給大家，具有很好的參考價(jià)值，需要的朋友一起跟隨小編來看看吧2019-02-02
這篇文章主要介紹了mac 安裝java1.8,包括下載過程及配置環(huán)境相關(guān)知識(shí)介紹,本文結(jié)合實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下2023-09-09