Swagger2 增加Api通用參數(shù)育勺;2018-01-19

對于現(xiàn)在前后端分離的架構(gòu)但荤,在調(diào)用API的時候,都需要使用token或者access-token的參數(shù)在header中涧至,那么在使用Swagger2的時候想在所有的API文檔的前部添加公共的需要傳入的參數(shù)腹躁,研究了半天,終于成功了南蓬,分享一下纺非;

  1. swagger2的依賴:
    <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
    </dependency>
    <dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
    </dependency>
    2.創(chuàng)建config配置類哑了,用于配置swagger的相關(guān)信息:
    2.1 使用的注解:
    @Configuration -- 標志配置類;
    @EnableSwagger2 -- 啟用swagger2烧颖;
    --- 我看在網(wǎng)上弱左,還有使用@EnableWebMvc的注解,但我沒有用炕淮,也是可以滴拆火;
    2.3: Docket對象:該對象用來配置文檔顯示的主要的信息;比如:掃描的controller包涂圆;以及該組API文檔顯示的名稱们镜;該組需要過濾的接口;公共參數(shù)的設置润歉;上配置:


    注釋.png

    本來想上傳代碼憎账,但是這個文本編譯器顯示的不是很理想,就直接上圖片吧卡辰;
    公共參數(shù)部分胞皱,有的大牛會在Docket外面創(chuàng)建一個static靜態(tài)的代碼塊存放,并初始化九妈。但是我試了以后會報空指針異常反砌,所以就放在Docket里面;defaultValue()占位符可以不用要萌朱;
    Docket里面重要的是select()后面的apis(Predicates.or(RequestHandlerSelectors.basePackage(""))) --該選擇用于定義該Docket掃描的controller包宴树,就可以將不同的controller分組使用,比如App的controller api 或者 后臺的api晶疼,通過groupName()分組命名酒贬;Paths(),里面定義該分組需要過濾的API,可以使用正則匹配翠霍,也可以選擇any(),所有的锭吨。如果在這里包配置錯了或者路徑匹配錯了,啟動的時候就會報空指針異常寒匙,導致項目啟動失斄闳纭;通過globalOperationParameters()選項锄弱,將通用的參數(shù)集合添加進來考蕾,就可以了啟用了;
    對應的ui上的頁面上会宪,上圖:


    頁面.png

    3:ApiInfo對象:
    該對象很簡單肖卧,就是定義左上角的信息,比如該文檔的名稱掸鹅,對應的描述塞帐,以及作者的信息等沟沙;
    4 這次踩得坑比較多的就是空指針異常,以及頁面顯示不出來壁榕,甚至接口顯示不出來的狀況矛紫。這些錯誤,不出意外的話都是配置錯誤牌里。還有就是static靜態(tài)代碼塊颊咬,建議不要使用靜態(tài)代碼塊初始化,否則會報錯牡辽;
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末喳篇,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子态辛,更是在濱河造成了極大的恐慌麸澜,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,729評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件奏黑,死亡現(xiàn)場離奇詭異炊邦,居然都是意外死亡,警方通過查閱死者的電腦和手機熟史,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,226評論 3 399
  • 文/潘曉璐 我一進店門馁害,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人蹂匹,你說我怎么就攤上這事碘菜。” “怎么了限寞?”我有些...
    開封第一講書人閱讀 169,461評論 0 362
  • 文/不壞的土叔 我叫張陵忍啸,是天一觀的道長。 經(jīng)常有香客問我履植,道長计雌,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 60,135評論 1 300
  • 正文 為了忘掉前任静尼,我火速辦了婚禮白粉,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘鼠渺。我一直安慰自己,他們只是感情好眷细,可當我...
    茶點故事閱讀 69,130評論 6 398
  • 文/花漫 我一把揭開白布拦盹。 她就那樣靜靜地躺著,像睡著了一般溪椎。 火紅的嫁衣襯著肌膚如雪普舆。 梳的紋絲不亂的頭發(fā)上恬口,一...
    開封第一講書人閱讀 52,736評論 1 312
  • 那天,我揣著相機與錄音沼侣,去河邊找鬼祖能。 笑死,一個胖子當著我的面吹牛蛾洛,可吹牛的內(nèi)容都是我干的养铸。 我是一名探鬼主播,決...
    沈念sama閱讀 41,179評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼轧膘,長吁一口氣:“原來是場噩夢啊……” “哼钞螟!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起谎碍,我...
    開封第一講書人閱讀 40,124評論 0 277
  • 序言:老撾萬榮一對情侶失蹤鳞滨,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后蟆淀,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體拯啦,經(jīng)...
    沈念sama閱讀 46,657評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,723評論 3 342
  • 正文 我和宋清朗相戀三年熔任,在試婚紗的時候發(fā)現(xiàn)自己被綠了提岔。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,872評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡笋敞,死狀恐怖碱蒙,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情夯巷,我是刑警寧澤赛惩,帶...
    沈念sama閱讀 36,533評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站趁餐,受9級特大地震影響喷兼,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜后雷,卻給世界環(huán)境...
    茶點故事閱讀 42,213評論 3 336
  • 文/蒙蒙 一季惯、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧臀突,春花似錦勉抓、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,700評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至梳码,卻和暖如春隐圾,著一層夾襖步出監(jiān)牢的瞬間伍掀,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,819評論 1 274
  • 我被黑心中介騙來泰國打工暇藏, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留箩言,地道東北人驾霜。 一個月前我還...
    沈念sama閱讀 49,304評論 3 379
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親翘悉。 傳聞我的和親對象是個殘疾皇子领追,可洞房花燭夜當晚...
    茶點故事閱讀 45,876評論 2 361

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理忽冻,服務發(fā)現(xiàn)芬沉,斷路器,智...
    卡卡羅2017閱讀 134,716評論 18 139
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,867評論 6 342
  • 工作到現(xiàn)在快要1年半了,一直沒有時間自己從頭搭建個框架,這個周末實在是無聊,真的不想打lol了,(黑色玫瑰開黑的喊...
    MacSam閱讀 6,302評論 7 20
  • spring官方文檔:http://docs.spring.io/spring/docs/current/spri...
    牛馬風情閱讀 1,691評論 0 3
  • Spring 技術(shù)筆記Day 1 預熱知識一趣倾、 基本術(shù)語Blob類型聘惦,二進制對象Object Graph:對象圖...
    OchardBird閱讀 979評論 0 2