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

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接口(一)

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,517評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,087評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,521評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,493評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,207評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,603評論 1 325
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,624評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,813評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,364評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,110評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,305評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,874評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,532評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,953評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,209評論 1 291
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,033評論 3 396
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,268評論 2 375