注解屬性說明

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

swagger配置及使用

總結

以上是生活随笔為你收集整理的swagger2注解说明文档的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。