swagger注解及使用說明

用在類上:

@Api()? ? 用在類上疙驾,說明類得作用(標(biāo)識這個類是swagger得資源)

? ? tags:表說明

? ? value:表說明可使用tags代替

@ApiIgnore()? ? 用于類、方法脖阵、方法參數(shù)(表示這個方法或類被忽略)? ? ??


用在方法上:

@ApiOperation()? ? 用在方法上,說明方法得作用(表示一個http請求得操作)

? ? value? ? 用于方法描述

? ? notes? ? 用于提示內(nèi)容

? ? tags? ? 可以重新分組

@ApiImplicitParams? ? 用在方法上蟋座,包含一組參數(shù)說明粟关,A皮Implicit Param[] value() 包含多個@ApoIimplicitParam

@ApiImplicitParam()? ? 用在@ApiImplicitParams注解中,指定一個請求參數(shù)得各個方面

? ? paramType? ? 參數(shù)放在那個地方

? ? ? ? header:請求參數(shù)得獲取@RequestHeader

? ? ? ? query:請求參數(shù)得獲取@RequestParam

? ? ? ? path(用于restful接口):請求參數(shù)得獲取@PathVariable

? ? ? ? body:(不常用)

? ? ? ? form:(不常用)

? ? name? ? 參數(shù)名

? ? dataType? ? 參數(shù)類型

? ? required? ? 參數(shù)是否必填

? ? value? ? 參數(shù)說明

? ? defaultValue? ? 參數(shù)得默認(rèn)值

@ApiResponses? ? 表示一組響應(yīng)

@ApiResponse? ? 用在@ApiResponses中用于表達(dá)一個錯誤得響應(yīng)信息

? ? code? ? 數(shù)字

? ? message? ? 信息

? ? response? ? 拋出異常得類

@ApiParam()? ? 用于方法俯萎,參數(shù),字段說明运杭,表示對參數(shù)的添加元數(shù)據(jù)(說明是否必填等)

? ? name? ? 參數(shù)名

? ? value? ? 參數(shù)說明

? ? required? ? 是否必填


實(shí)體類:

@ApiModel()? ? 描述一個model得信息夫啊,一般用在post創(chuàng)建得時候,使用@RequestBody得場景辆憔,請求西安舒無法使用@ApiImplicitParam注解進(jìn)行描述時(表示對類進(jìn)行說明撇眯,參數(shù)用實(shí)體類接收)

? ? value? ? 表示對象名

? ? description? ? 描述

@ApiModelProperty()? ? 描述對model屬性得說明或數(shù)據(jù)操作的更改

? ? value? ? 字段說明

? ? name? ? 重寫屬性名字

? ? dataType? ? 重寫屬性類型

? ? required? ? 是否必填

? ? example? ? 舉例說明

? ? hidden? ? 隱藏

? @Authorization? ? 聲明要在資源上操作使用的授權(quán)方案

? @AuthorizationScope? ? 介紹一個OAuth2授權(quán)范圍

? @ResponseHeader? ? 響應(yīng)頭設(shè)置,使用方法

? @ApiSort? ? 排序

? ? ? value? ? int值

??

??

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末躁愿,一起剝皮案震驚了整個濱河市叛本,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌彤钟,老刑警劉巖来候,帶你破解...
    沈念sama閱讀 221,198評論 6 514
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異逸雹,居然都是意外死亡营搅,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,334評論 3 398
  • 文/潘曉璐 我一進(jìn)店門梆砸,熙熙樓的掌柜王于貴愁眉苦臉地迎上來转质,“玉大人,你說我怎么就攤上這事帖世⌒菪罚” “怎么了?”我有些...
    開封第一講書人閱讀 167,643評論 0 360
  • 文/不壞的土叔 我叫張陵日矫,是天一觀的道長赂弓。 經(jīng)常有香客問我,道長哪轿,這世上最難降的妖魔是什么盈魁? 我笑而不...
    開封第一講書人閱讀 59,495評論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮窃诉,結(jié)果婚禮上杨耙,老公的妹妹穿的比我還像新娘。我一直安慰自己飘痛,他們只是感情好珊膜,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,502評論 6 397
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著敦冬,像睡著了一般辅搬。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,156評論 1 308
  • 那天堪遂,我揣著相機(jī)與錄音介蛉,去河邊找鬼。 笑死溶褪,一個胖子當(dāng)著我的面吹牛币旧,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播猿妈,決...
    沈念sama閱讀 40,743評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼吹菱,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了彭则?” 一聲冷哼從身側(cè)響起鳍刷,我...
    開封第一講書人閱讀 39,659評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎俯抖,沒想到半個月后输瓜,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,200評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡芬萍,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,282評論 3 340
  • 正文 我和宋清朗相戀三年尤揣,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片柬祠。...
    茶點(diǎn)故事閱讀 40,424評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡北戏,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出漫蛔,到底是詐尸還是另有隱情嗜愈,我是刑警寧澤,帶...
    沈念sama閱讀 36,107評論 5 349
  • 正文 年R本政府宣布莽龟,位于F島的核電站芝硬,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏轧房。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,789評論 3 333
  • 文/蒙蒙 一绍绘、第九天 我趴在偏房一處隱蔽的房頂上張望奶镶。 院中可真熱鬧,春花似錦陪拘、人聲如沸厂镇。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,264評論 0 23
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽捺信。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間迄靠,已是汗流浹背秒咨。 一陣腳步聲響...
    開封第一講書人閱讀 33,390評論 1 271
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留掌挚,地道東北人雨席。 一個月前我還...
    沈念sama閱讀 48,798評論 3 376
  • 正文 我出身青樓,卻偏偏與公主長得像吠式,于是被迫代替她去往敵國和親陡厘。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,435評論 2 359