Spring-Boot工程集成Swagger2

聲明:

此文章只講述Spring-Boot如何集成和使用Swagger2


下面開始具體步驟:

第一步:導(dǎo)入依賴jar包

建議直接在父工程的pom文件中導(dǎo)入,其下的子工程都可以直接使用,無需再次導(dǎo)包率挣,方便

<dependency>

????<groupId>io.springfox</groupId>

????<artifactId>springfox-swagger-ui</artifactId>

????<version>2.9.2</version>

</dependency>

<dependency>

????<groupId>io.springfox</groupId>

????<artifactId>springfox-swagger2</artifactId>

????<version>2.9.2</version>

</dependency>

第二步:編寫Swagger的配置類

在所需要使用swagger的子工程里編寫此配置類

@Configuration

@EnableSwagger2

public class Swagger2Configuration {

????//api接口包掃描路徑

????public static final String SWAGGER_SCAN_BASE_PACKAGE = "com.changgou.goods";

????public static final String VERSION = "1.0.0";

????@Bean

????public Docket createRestApi() {

????????return new Docket(DocumentationType.SWAGGER_2)

????????????????????.apiInfo(apiInfo())

????????????????????.select() ????????????????????

????????????????????.apis(RequestHandlerSelectors.basePackage(SWAGGER_SCAN_BASE_PACKAGE)) ????????????????????.paths(PathSelectors.any()) // 可以根據(jù)url路徑設(shè)置哪些請求加入文檔菠发,忽略哪些請求

????????????????????.build();

}

????private ApiInfo apiInfo() {

????????return new ApiInfoBuilder()

????????????????????.title("單詞計數(shù)服務(wù)") //設(shè)置文檔的標(biāo)題

????????????????????.description("單詞計數(shù)服務(wù) API 接口文檔") // 設(shè)置文檔的描述

????????????????????.version(VERSION) // 設(shè)置文檔的版本信息-> 1.0.0 Version information? ? ? ? ? ? ? ? ? ?

????????????????????.termsOfServiceUrl("http://www.baidu.com") // 設(shè)置文檔的License信息->1.3 Licensinformation

????????????????????.build();

????}

}


第三步:開始使用

瀏覽器輸入:

http://localhost:9001/swagger-ui.html

即可訪問笼痛,注意:ip和端口根據(jù)自身啟動的項目編寫

登陸成功后顯示如下圖:

展開類維度的接口列表祈秕,如brand-controller唯蝶,頁面會列出該類中定義的所有接口访雪。點(diǎn)擊任意接口详瑞,可查看該接口的 url 路徑、請求類型冬阳、參數(shù)描述和返回碼說明等信息蛤虐。


這里我們來測試一下findById這個接口



點(diǎn)擊Try it out可以傳入?yún)?shù)進(jìn)行測試



注:此文借鑒于

http://www.reibang.com/p/c79f6a14f6c9

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市肝陪,隨后出現(xiàn)的幾起案子驳庭,更是在濱河造成了極大的恐慌,老刑警劉巖氯窍,帶你破解...
    沈念sama閱讀 206,482評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件饲常,死亡現(xiàn)場離奇詭異,居然都是意外死亡狼讨,警方通過查閱死者的電腦和手機(jī)贝淤,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來政供,“玉大人播聪,你說我怎么就攤上這事〔几簦” “怎么了离陶?”我有些...
    開封第一講書人閱讀 152,762評論 0 342
  • 文/不壞的土叔 我叫張陵,是天一觀的道長衅檀。 經(jīng)常有香客問我招刨,道長,這世上最難降的妖魔是什么哀军? 我笑而不...
    開封第一講書人閱讀 55,273評論 1 279
  • 正文 為了忘掉前任沉眶,我火速辦了婚禮,結(jié)果婚禮上杉适,老公的妹妹穿的比我還像新娘谎倔。我一直安慰自己,他們只是感情好猿推,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,289評論 5 373
  • 文/花漫 我一把揭開白布传藏。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪毯侦。 梳的紋絲不亂的頭發(fā)上哭靖,一...
    開封第一講書人閱讀 49,046評論 1 285
  • 那天,我揣著相機(jī)與錄音侈离,去河邊找鬼试幽。 笑死,一個胖子當(dāng)著我的面吹牛卦碾,可吹牛的內(nèi)容都是我干的铺坞。 我是一名探鬼主播,決...
    沈念sama閱讀 38,351評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼洲胖,長吁一口氣:“原來是場噩夢啊……” “哼济榨!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起绿映,我...
    開封第一講書人閱讀 36,988評論 0 259
  • 序言:老撾萬榮一對情侶失蹤擒滑,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后叉弦,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體丐一,經(jīng)...
    沈念sama閱讀 43,476評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,948評論 2 324
  • 正文 我和宋清朗相戀三年淹冰,在試婚紗的時候發(fā)現(xiàn)自己被綠了库车。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,064評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡樱拴,死狀恐怖柠衍,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情晶乔,我是刑警寧澤珍坊,帶...
    沈念sama閱讀 33,712評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站瘪弓,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏禽最。R本人自食惡果不足惜腺怯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,261評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望川无。 院中可真熱鬧呛占,春花似錦、人聲如沸懦趋。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至帜篇,卻和暖如春糙捺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背笙隙。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評論 1 262
  • 我被黑心中介騙來泰國打工洪灯, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人竟痰。 一個月前我還...
    沈念sama閱讀 45,511評論 2 354
  • 正文 我出身青樓签钩,卻偏偏與公主長得像,于是被迫代替她去往敵國和親坏快。 傳聞我的和親對象是個殘疾皇子铅檩,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,802評論 2 345