Spring boot+Swagger配置無侵入式Restful介面(二)

weixin_33670713發表於2018-03-12

maven依賴自動配置

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

這裡我就不一一講解了,具體的原始碼我已上傳碼雲.碼雲地址maven自動配置地址

  1. 在pom.xml 新增maven依賴

這裡需要說明一下,因為我還沒有上傳中央儲存庫,所以,直接依賴是找不到的,所以,你就下載下來,地址是(https://gitee.com/xiangyue520/swagger2), 然後進入我的這個專案根目錄mvn clean install 一下,輸入下面這個依賴就可以了

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

在這裡我給大家提供了很多自由化的配置了,當然你也可以不用配置,因為所有的選項都是可選的

注意:如果你要進行自定義配置的話,需要預設加上字首:swagger.來配置屬性,給個demo吧,配置的地方是application.properties或者application.yml,引數那麼多,我就不一個個來了哈,可以自己配置來看看效果,其實,我都沒配置完過,哈哈,要是有問題的話,請大家及時指出,以便即時更正.

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

配置引數

  • title(可選) 介面的標題,具體就不多說了吧,可以自己試著玩,預設是Swagger Restful API

  • description(可選) 介面的描述,預設是This is a swagger api desc

  • version(可選) 介面的版本,預設是1.0.0

  • groupName(可選) 介面所屬的組,預設沒有,當然,你可以自己寫下試試

  • basePackage(可選) 掃描的包路徑,預設沒有,掃描下面的所有的@Controller和@RequestMapping的對映

  • termsOfService(可選) 服務條款的地址,預設沒有

  • contactName(可選) 聯絡人,預設沒有

  • contactUrl(可選) 聯絡的url,預設沒有

  • contactEmail(可選) 聯絡的email,預設沒有

  • licenseName(可選) 證書名,預設沒有

  • licenseUrl(可選) 證書的url,預設沒有

  1. 啟動和使用
    啟動的話,和前面沒什麼區別,使用也是和前面的那種方法是一樣的,開啟瀏覽器訪問 http://localhost:埠號/swagger-ui.html

  2. 移除依賴

    額,這個嘛,看你專案使用profile沒有,如果有的話,就一般放在dev裡面,還是一樣來個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>

或者直接就放在整個pom.xml的依賴裡面也行,但是一般為了減少依賴包的大小,推薦上面那種啦,這個整體的依賴就不用給demo了吧?相信你一定會的.

刪除的話,就把上面這個依賴選中,刪除就搞定了,要是你想以後用呢,選擇註釋掉也可以,看你怎麼開心怎麼弄.

  1. 後續

經歷了上面的一波操作,如果還是有問題的話,就請聯絡我吧,嘿嘿,不是經常看,所以可能回覆的比較慢,不過,應該不會遇到什麼問題的,一般的問題的話,百度一下,你就知道啦.

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

相關文章