注解屬性說(shuō)明

@Api		用于類上，說(shuō)明該類的作用。可以標(biāo)記一個(gè)controller類作為swagger的文檔資源
	value	url的路徑
	tags	如果設(shè)置這個(gè)值，value的值會(huì)被覆蓋
	description	對(duì)Api資源的描述
	basePath	基本路徑，可以不用配置
	position	設(shè)置多個(gè)Api顯示的順序位置
	produces	For example, “application/json, application/xml”
	consumes	For example, “application/json, application/xml”
	protocols	Possible values: http, https, ws, wss.
	authorizations	高級(jí)特性認(rèn)證時(shí)配置
	hidden	配置為true 將在文檔中隱藏
@ApiOperation		用于方法上，說(shuō)明方法的作用，每一個(gè)url資源的定義
	value	url的路徑
	tags	如果設(shè)置這個(gè)值，value的值會(huì)被覆蓋
	notes	對(duì)Api資源的描述
	position	設(shè)置多個(gè)Api顯示的順序位置
	produces	For example, “application/json, application/xml”
	consumes	For example, “application/json, application/xml”
	protocols	Possible values: http, https, ws, wss.
	authorizations	高級(jí)特性認(rèn)證時(shí)配置
	hidden	配置為true 將在文檔中隱藏
	response	返回的對(duì)象
	responseContainer	包含的這些對(duì)象是有效的 “List”，“Set”，“Map”，其他無(wú)效
	httpMethod	get,head,post,put,delete,options,patch
	code	http的狀態(tài)碼，默認(rèn)200
	extensions	擴(kuò)展屬性
@ApiParam		用于方法、參數(shù)、字段上，表示請(qǐng)求屬性
	name	屬性名稱
	value	屬性值
	defaultValue	默認(rèn)屬性值
	allowableValues	可以不用配置
	required	該屬性是否必填
	access
	allowMultiple	默認(rèn)為false
	hidden	是否隱藏該屬性
	example	示例
@ApiResponse		用于方法上，響應(yīng)配置
	code	Http狀態(tài)碼
	message	描述
	response	默認(rèn)響應(yīng)類Void
	reference
	responseHeaders	參考下方ResponseHeader的配置
	responseContainer	包含的這些對(duì)象是有效的 “List”，“Set”，“Map”，其他無(wú)效
@ApiResponses		用于方法上，響應(yīng)集配置
	value	多個(gè)ApiResponse配置
@ResponseHeader		用于方法上，響應(yīng)頭設(shè)置
	name	響應(yīng)頭名稱
	description	頭部描述
	response	默認(rèn)響應(yīng)類Void
	responseContainer	參考ApiOperation中配置
@ApiImplicitParams		用于方法上，包含一組參數(shù)說(shuō)明
@ApiImplicitParam		用于方法上，用在@ApiImplicitParams 注解中，指定一個(gè)請(qǐng)求參數(shù)的各個(gè)方面
	paramType	參數(shù)放在哪個(gè)地方。 · header 參數(shù)在request headers 里邊提交（@RequestHeader）； · query 直接跟參數(shù)完成自動(dòng)映射賦值（@RequestParam）； · path 用于restful接口，以地址的形式提交數(shù)據(jù)（@PathVariable）； · body 以流的形式提交 僅支持POST（@RequestBody）； · form 以form表單的形式提交 僅支持POST
	name	參數(shù)名
	value	參數(shù)的漢字說(shuō)明，解釋
	dataType	參數(shù)類型，默認(rèn)String，其他值dataType=“Integer”，無(wú)用
	required	是否必填
	defaultValue	參數(shù)的默認(rèn)值
@ApiModel		用于類上，描述一個(gè)Model的信息 （這種一般用在post創(chuàng)建的時(shí)候，使用@RequestBody這樣的場(chǎng)景，請(qǐng)求參數(shù)無(wú)法使用@ApiImplicitParam注解進(jìn)行描述的時(shí)候）
@ApiModelProperty		用于方法、字段上，描述一個(gè)model的屬性
@Apilgnore		用于類、屬性、方法上，忽略某項(xiàng)api，使用@ApiIgnore

swagger配置及使用

總結(jié)

以上是生活随笔為你收集整理的swagger2注解说明文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。