用在類上:
@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值
??
??