SpringBoot項目集成swagger

Swagger是一個開源軟件框架企软,由大型工具生態(tài)系統(tǒng)支持姑廉,可幫助開發(fā)人員設計,構建悔政,記錄和使用RESTful?Web服務晚吞。雖然大多數用戶通過Swagger UI工具識別Swagger,但Swagger工具集包括對自動文檔谋国,代碼生成和測試用例生成的支持槽地。

使用了swagger我們能做什么呢?

想問一下廣大的后端開發(fā)者是否為了在接口開完完成的時候因為需要些接口文檔而煩惱芦瘾,當然網上很多接口文檔書寫工具捌蚊,但是從現在開始,你們可以省去寫接口文檔的時間了近弟,不需要再為寫接口文檔而煩惱缅糟,使用了swagger能省去開發(fā)者省去寫接口文檔的時間,而且swagger是基于restful的接口框架祷愉,開發(fā)者只需要貼注解窗宦,寫注釋就能夠自動生成接口文檔赦颇,聽起來是不是很強大很方便,沒錯swagger就是這么強大

如何在項目中集成swagger赴涵?

那么重點來了媒怯,下面就以SpringBoot項目集成swagger舉例

首先需要導入Maven依賴

<groupId>io.springfox

? ? <artifactId>springfox-swagger2

? ? <version>2.7.0

? ? <groupId>io.springfox

? ? <artifactId>springfox-swagger-ui

? ? <version>2.7.0

</dependency>

接著新建一個swaggerconfig的配置類進行swagger獨有的配置

可能到這里有有人問,這么快髓窜?沒錯扇苞,就是這么快,這么簡單纱烘,我們的SpringBoot項目就集成了swagger了杨拐,接下來就是用了,下面就是各常用注解的使用擂啥。

@Api(description ="貼在類上,整個controller的注釋")

@ApiOperation(value ="貼在方法上帆阳,方法的注釋")

@ApiModelProperty(value ="貼在對象里的字段上")

注:當你需要的參數是一個對象的時候哺壶,對象里的字段是不是無法進行注釋,當你在字段上貼上此注解即可

@ApiImplicitParams?: 用在方法上包含一組參數說明蜒谤。

@ApiImplicitParam:用來注解來給方法入參增加說明山宾。

@ApiResponses:用于表示一組響應

@ApiResponse:用在@ApiResponses中,一般用于表達一個錯誤的響應信息

l?code:數字鳍徽,例如400

l?message:信息资锰,例如"請求參數沒填好"

l?response:拋出異常的類

@ApiModel:描述一個Model的信息(一般用在請求參數無法使用@ApiImplicitParam注解進行描述的時候)

補充說明:

paramType:指定參數放在哪個地方header:請求參數放置于Request Header,使用@RequestHeader獲取

query:請求參數放置于請求地址阶祭,使用@RequestParam獲取

path:(用于restful接口)-->請求參數的獲缺炼拧:@PathVariable

body:(不常用)

form(不常用)

name:參數名?

dataType:參數類型?

required:參數是否必須傳 true /false

value:說明參數的意思?

defaultValue:參數的默認值


總結的不好,請見諒濒募!

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末鞭盟,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子瑰剃,更是在濱河造成了極大的恐慌齿诉,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,386評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件晌姚,死亡現場離奇詭異粤剧,居然都是意外死亡,警方通過查閱死者的電腦和手機挥唠,發(fā)現死者居然都...
    沈念sama閱讀 93,142評論 3 394
  • 文/潘曉璐 我一進店門抵恋,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人猛遍,你說我怎么就攤上這事馋记『牌拢” “怎么了?”我有些...
    開封第一講書人閱讀 164,704評論 0 353
  • 文/不壞的土叔 我叫張陵梯醒,是天一觀的道長宽堆。 經常有香客問我,道長茸习,這世上最難降的妖魔是什么畜隶? 我笑而不...
    開封第一講書人閱讀 58,702評論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮号胚,結果婚禮上籽慢,老公的妹妹穿的比我還像新娘。我一直安慰自己猫胁,他們只是感情好箱亿,可當我...
    茶點故事閱讀 67,716評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著弃秆,像睡著了一般届惋。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上菠赚,一...
    開封第一講書人閱讀 51,573評論 1 305
  • 那天脑豹,我揣著相機與錄音,去河邊找鬼衡查。 笑死瘩欺,一個胖子當著我的面吹牛,可吹牛的內容都是我干的拌牲。 我是一名探鬼主播俱饿,決...
    沈念sama閱讀 40,314評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼们拙!你這毒婦竟也來了稍途?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,230評論 0 276
  • 序言:老撾萬榮一對情侶失蹤砚婆,失蹤者是張志新(化名)和其女友劉穎械拍,沒想到半個月后,有當地人在樹林里發(fā)現了一具尸體装盯,經...
    沈念sama閱讀 45,680評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡坷虑,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,873評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現自己被綠了埂奈。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片迄损。...
    茶點故事閱讀 39,991評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖账磺,靈堂內的尸體忽然破棺而出芹敌,到底是詐尸還是另有隱情痊远,我是刑警寧澤,帶...
    沈念sama閱讀 35,706評論 5 346
  • 正文 年R本政府宣布氏捞,位于F島的核電站碧聪,受9級特大地震影響,放射性物質發(fā)生泄漏液茎。R本人自食惡果不足惜逞姿,卻給世界環(huán)境...
    茶點故事閱讀 41,329評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望捆等。 院中可真熱鬧滞造,春花似錦、人聲如沸栋烤。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,910評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽班缎。三九已至蝴光,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間达址,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,038評論 1 270
  • 我被黑心中介騙來泰國打工趁耗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留沉唠,地道東北人。 一個月前我還...
    沈念sama閱讀 48,158評論 3 370
  • 正文 我出身青樓苛败,卻偏偏與公主長得像满葛,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子罢屈,可洞房花燭夜當晚...
    茶點故事閱讀 44,941評論 2 355

推薦閱讀更多精彩內容