Spring boot+Swagger配置無侵入式Restful接口(二)

maven依賴自動配置

額,看了前面第一種配置方式,是不是感覺有點(diǎn)麻煩呢?我也覺得,到時(shí)候去掉的時(shí)候,還需要進(jìn)行刪除配置啊,一大堆,還有可能到時(shí)候根本不知道.
所以,我決定自己寫個(gè)讓它自己就可以完成配置的東東,嗯,說干就干

這里我就不一一講解了,具體的源碼我已上傳碼云.碼云地址maven自動配置地址

  1. 在pom.xml 添加maven依賴

這里需要說明一下,因?yàn)槲疫€沒有上傳中央存儲庫,所以,直接依賴是找不到的,所以,你就下載下來,地址是(https://gitee.com/xiangyue520/swagger2), 然后進(jìn)入我的這個(gè)項(xiàng)目根目錄mvn clean install 一下,輸入下面這個(gè)依賴就可以了

<dependency>
    <groupId>com.wanggan</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>
  1. 配置

在這里我給大家提供了很多自由化的配置了,當(dāng)然你也可以不用配置,因?yàn)樗械倪x項(xiàng)都是可選的

注意:如果你要進(jìn)行自定義配置的話,需要默認(rèn)加上前綴:swagger.來配置屬性,給個(gè)demo吧,配置的地方是application.properties或者application.yml,參數(shù)那么多,我就不一個(gè)個(gè)來了哈,可以自己配置來看看效果,其實(shí),我都沒配置完過,哈哈,要是有問題的話,請大家及時(shí)指出,以便即時(shí)更正.

swagger.title = Swagger API Demo
swagger.description = This is swagger api describle demo
swagger.version = 1.1.1

配置參數(shù)

  • title(可選) 接口的標(biāo)題,具體就不多說了吧,可以自己試著玩,默認(rèn)是Swagger Restful API

  • description(可選) 接口的描述,默認(rèn)是This is a swagger api desc

  • version(可選) 接口的版本,默認(rèn)是1.0.0

  • groupName(可選) 接口所屬的組,默認(rèn)沒有,當(dāng)然,你可以自己寫下試試

  • basePackage(可選) 掃描的包路徑,默認(rèn)沒有,掃描下面的所有的@Controller和@RequestMapping的映射

  • termsOfService(可選) 服務(wù)條款的地址,默認(rèn)沒有

  • contactName(可選) 聯(lián)系人,默認(rèn)沒有

  • contactUrl(可選) 聯(lián)系的url,默認(rèn)沒有

  • contactEmail(可選) 聯(lián)系的email,默認(rèn)沒有

  • licenseName(可選) 證書名,默認(rèn)沒有

  • licenseUrl(可選) 證書的url,默認(rèn)沒有

  1. 啟動和使用
    啟動的話,和前面沒什么區(qū)別,使用也是和前面的那種方法是一樣的,打開瀏覽器訪問 http://localhost:端口號/swagger-ui.html

  2. 移除依賴

    額,這個(gè)嘛,看你項(xiàng)目使用profile沒有,如果有的話,就一般放在dev里面,還是一樣來個(gè)demo吧

<profiles>
    <profile>
        <id>dev</id>
        <dependencies>
            <dependency>
                <groupId>com.wanggan</groupId>
                <artifactId>swagger-spring-boot-starter</artifactId>
                <version>1.0.0</version>
            </dependency>
        </dependencies>
    </profile>
</profiles>

或者直接就放在整個(gè)pom.xml的依賴?yán)锩嬉残?但是一般為了減少依賴包的大小,推薦上面那種啦,這個(gè)整體的依賴就不用給demo了吧?相信你一定會的.

刪除的話,就把上面這個(gè)依賴選中,刪除就搞定了,要是你想以后用呢,選擇注釋掉也可以,看你怎么開心怎么弄.

  1. 后續(xù)

經(jīng)歷了上面的一波操作,如果還是有問題的話,就請聯(lián)系我吧,嘿嘿,不是經(jīng)???所以可能回復(fù)的比較慢,不過,應(yīng)該不會遇到什么問題的,一般的問題的話,百度一下,你就知道啦.

如果你想再看看前面的自己配置的話,給個(gè)友情鏈接吧,Spring boot+Swagger配置無侵入式Restful接口(一)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容