swagger2注解说明文档

注解	属性	说明
@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配置及使用