Swagger2相關(guān)注解

針對(duì)類相關(guān)注解:@API,tags和value停忿。其中tags與value都表示說明驾讲,一般使用tags進(jìn)行替代,會(huì)自動(dòng)覆蓋value的說明席赂。
針對(duì)方法的注解:@ApiOperation吮铭。用于方法,常用value與tags颅停。value用于方法描述谓晌,notes用于提示具體內(nèi)容。如果一致可不寫癞揉。
針對(duì)參數(shù)的部分注解:@ApiParam()用于方法纸肉,做部分的參數(shù),字段說明喊熟。name:參數(shù)名柏肪。value:參數(shù)說明。如果name和傳遞的參數(shù)一致可省略芥牌。
針對(duì)實(shí)體類: @APIModel()用于實(shí)體類烦味,參數(shù)是value和description.當(dāng)前類對(duì)象及對(duì)應(yīng)描述,都可省略壁拉。
針對(duì)實(shí)體類的屬性:@ApiModelProperty谬俄,常用的是name.value及example,其中name可省略,主要是用來(lái)重寫屬性類型的弃理。如何屬性名一致可不寫溃论。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市案铺,隨后出現(xiàn)的幾起案子蔬芥,更是在濱河造成了極大的恐慌,老刑警劉巖控汉,帶你破解...
    沈念sama閱讀 207,113評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件笔诵,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡姑子,警方通過查閱死者的電腦和手機(jī)乎婿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評(píng)論 2 381
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)街佑,“玉大人谢翎,你說我怎么就攤上這事捍靠。” “怎么了森逮?”我有些...
    開封第一講書人閱讀 153,340評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵榨婆,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我褒侧,道長(zhǎng)良风,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,449評(píng)論 1 279
  • 正文 為了忘掉前任闷供,我火速辦了婚禮烟央,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘歪脏。我一直安慰自己疑俭,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,445評(píng)論 5 374
  • 文/花漫 我一把揭開白布婿失。 她就那樣靜靜地躺著钞艇,像睡著了一般。 火紅的嫁衣襯著肌膚如雪移怯。 梳的紋絲不亂的頭發(fā)上香璃,一...
    開封第一講書人閱讀 49,166評(píng)論 1 284
  • 那天这难,我揣著相機(jī)與錄音舟误,去河邊找鬼。 笑死姻乓,一個(gè)胖子當(dāng)著我的面吹牛嵌溢,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播蹋岩,決...
    沈念sama閱讀 38,442評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼赖草,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了剪个?” 一聲冷哼從身側(cè)響起秧骑,我...
    開封第一講書人閱讀 37,105評(píng)論 0 261
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎扣囊,沒想到半個(gè)月后乎折,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,601評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡侵歇,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,066評(píng)論 2 325
  • 正文 我和宋清朗相戀三年骂澄,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片惕虑。...
    茶點(diǎn)故事閱讀 38,161評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡坟冲,死狀恐怖磨镶,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情健提,我是刑警寧澤琳猫,帶...
    沈念sama閱讀 33,792評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站私痹,受9級(jí)特大地震影響沸移,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜侄榴,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,351評(píng)論 3 307
  • 文/蒙蒙 一雹锣、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧癞蚕,春花似錦蕊爵、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至恒水,卻和暖如春会放,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背钉凌。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評(píng)論 1 261
  • 我被黑心中介騙來(lái)泰國(guó)打工咧最, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人御雕。 一個(gè)月前我還...
    沈念sama閱讀 45,618評(píng)論 2 355
  • 正文 我出身青樓矢沿,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親酸纲。 傳聞我的和親對(duì)象是個(gè)殘疾皇子捣鲸,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,916評(píng)論 2 344

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