怎么在springboot項目中使用swagger-spring-boot-starter

一直使用swagger恢口,最近發(fā)現(xiàn)一款在swagger基礎(chǔ)開發(fā)的api文檔接口生成框架swagger-spring-boot-starter聂渊。我們先看看他生成的效果吧差购。


1.加入依賴

2.添加配置

spring.swagger.enabled=true

spring.swagger.security.filter-plugin=true

# 配置

spring.swagger.api-key.key-name=myToken

# 2.0.1 版本新特性 (支持可選的 Bean 驗證插件)

# 配置賬號密碼

spring.swagger.security.username=battcn

spring.swagger.security.password=battcn

spring.swagger.base-package=com.cornerstone.verification.controller

# 關(guān)閉 JSR

spring.swagger.validator-plugin=false

3.啟動項目輸入:http://localhost:8083/swagger-ui.html 會有一個登陸接口 用戶密碼在配置文件里配置了。

4.一些swagger有用的注釋:

(1)在接口上加上這個

@ApiImplicitParams({

@ApiImplicitParam(name="domainId",value="系統(tǒng)number",dataType="String",required=true),

? ? ? ? @ApiImplicitParam(name="username",value="用戶名",dataType="String",required=true),

? ? ? ? @ApiImplicitParam(name="password",value="密碼",dataType="String",required=true),

? ? ? ? @ApiImplicitParam(name="redirect",value="重定向地址",dataType="String",required=false)

})

注釋參數(shù)信息汉嗽。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末欲逃,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子饼暑,更是在濱河造成了極大的恐慌稳析,老刑警劉巖洗做,帶你破解...
    沈念sama閱讀 206,968評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異彰居,居然都是意外死亡诚纸,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評論 2 382
  • 文/潘曉璐 我一進店門陈惰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來畦徘,“玉大人,你說我怎么就攤上這事奴潘【缮眨” “怎么了?”我有些...
    開封第一講書人閱讀 153,220評論 0 344
  • 文/不壞的土叔 我叫張陵画髓,是天一觀的道長掘剪。 經(jīng)常有香客問我,道長奈虾,這世上最難降的妖魔是什么夺谁? 我笑而不...
    開封第一講書人閱讀 55,416評論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮肉微,結(jié)果婚禮上匾鸥,老公的妹妹穿的比我還像新娘。我一直安慰自己碉纳,他們只是感情好勿负,可當(dāng)我...
    茶點故事閱讀 64,425評論 5 374
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著劳曹,像睡著了一般奴愉。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上铁孵,一...
    開封第一講書人閱讀 49,144評論 1 285
  • 那天锭硼,我揣著相機與錄音,去河邊找鬼蜕劝。 笑死檀头,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的岖沛。 我是一名探鬼主播暑始,決...
    沈念sama閱讀 38,432評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼婴削!你這毒婦竟也來了廊镜?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,088評論 0 261
  • 序言:老撾萬榮一對情侶失蹤馆蠕,失蹤者是張志新(化名)和其女友劉穎期升,沒想到半個月后惊奇,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,586評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡播赁,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,028評論 2 325
  • 正文 我和宋清朗相戀三年颂郎,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片容为。...
    茶點故事閱讀 38,137評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡乓序,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出坎背,到底是詐尸還是另有隱情替劈,我是刑警寧澤,帶...
    沈念sama閱讀 33,783評論 4 324
  • 正文 年R本政府宣布得滤,位于F島的核電站陨献,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏懂更。R本人自食惡果不足惜眨业,卻給世界環(huán)境...
    茶點故事閱讀 39,343評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望沮协。 院中可真熱鬧龄捡,春花似錦、人聲如沸慷暂。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,333評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽行瑞。三九已至奸腺,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間蘑辑,已是汗流浹背洋机。 一陣腳步聲響...
    開封第一講書人閱讀 31,559評論 1 262
  • 我被黑心中介騙來泰國打工坠宴, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留洋魂,地道東北人。 一個月前我還...
    沈念sama閱讀 45,595評論 2 355
  • 正文 我出身青樓喜鼓,卻偏偏與公主長得像副砍,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子庄岖,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,901評論 2 345

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