Swagger常用注解及说明

一、 swagger说明

        Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

二、swagger常用注解

   

注解名称	注解含义	使用目标	注解参数	参数含义	参数可取值
`@EnableSwagger2	开启Swagger注解	配置类上	无
`@Api	修饰整个类，对类进行描述	Controller上	value	值
			tags	分组
			description	描述
`@ApiIgnore	被注释的类将不会显示在Swagger上	Controller上	value	值
`@ApiOperation	用来描述一个类的方法	Controller中的方法上	value	描述
			tags	分组
`@ApiImplicitParam	修饰方法中的参数（一个）	方法上	name	参数名
			value	参数说明
			dataType	参数数据类型"String"
			paramType	参数取值类型	form:以form表单传递，仅支持POST
					query(对应@RequestParam注解)
					body:默认，仅支持POST（@RequestBody）
					path(@pathVarible)
					header(参数在header中)
			required	参数是否必传
`@ApiImplicitParams	修饰方法中的参数（@ApiImplicitParams的集合）	方法上	`@ApiImplicitParam	`@ApiImplicitParams的集合
`@ApiRaram	修饰方法中的参数	方法上
`@ApiReponse	修饰方法的返回值	方法上	code	响应状态码
			message	方法返回值信息说明
			class	方法所属的class
`@ApiReponses	修饰方法返回值的集合	方法上
`@ApiModel	标识一个类为model	一般作用在实体上	value
			description
`@ApiModelProperty	标识model中的各个属性	作用于实体的各个属性上	value
			name
			required

   三、 查看swagger接口文档

          访问：http://ip:port/swagger-ui.html