JAVA-swagger2注解

注解使用

@Api 接口集合

@Api(tags = “接口集合”,value = “接口的一个集合”)
在类上面添加,可以修改这个接口集合的名称,类似于目录

属性 Api:(
	tags: 接口名称
	value : 接口描述
)

@Api(tags = "接口集合",value = "接口的一个集合")
public class AController{}

@ApiOperation 接口说明

@ApiOperation(value=“查询接口”, notes="根据输入**")**
在对应方法上添加便可以修改接口名称描述,类似于跳转到对于接口的页面.

属性ApiOperation:(
		value = 接口说明, 
		httpMethod = 接口请求方式, 
		response =接口返回参数类型, 
		notes = 接口描述,
		consumes = 接收数据类型
)

@ApiOperation(value="查询接口", notes="查询接口描述",httpMethod = "POST",consumes = MediaType.APPLICATION_JSON_VALUE)
public Objcat getA(){}

@ApiImplicitParam 接口参数

处理单个参数接收时的说明

@ApiImplicitParam(name = "username", value = "用户名", required = true, paramType="query")**
属性ApiImplicitParam:(
	name ：参数名。 
	value ： 参数的具体意义，作用。 
	required ： 参数是否必填。 
	dataType ：参数的数据类型。 
	 paramType ：查询参数类型，这里有几种形式：{
	 path 以地址的形式提交数据
		query 与方法中完成自动映射赋值
		body 以流的形式提交 仅支持POST(不常用)
		header 在请求头里携带的参数使用
		form 以form表单的形式提交 仅支持POST
	}
)

效果图:

@ApiImplicitParams() 接口参数集合

     @ApiImplicitParams({
        @ApiImplicitParam(name = "username", value = "用户名", required = true, paramType="query"),
        @ApiImplicitParam(name = "age", value = "用户年龄", required = true, paramType="query")
     })

@ApiModel() 参数类注解

如果参数使用类接收的话就可以使用这个,用来描述这个类

@ApiModel(value = "用户接口DTO类")

ApiModel:(
value: 类名
description: 提供详细的类描述
parent: 可以继承父类
discriminatory: 支持模型继承和多态
subTypes: 从此模型继承的子类型数组
)

效果图:

@ApiModelProperty 属性注解

用于@ApiModel() 下面的属性注解

 @ApiModelProperty(value = "用户名称", example = "xiaoming", required = false)
 ApiModelProperty:(
	 value:字段说明
	name:重写属性名字
	dataType:重写属性类型
	required:是否必填
	example:举例说明
	hidden:隐藏
)

@ApiResponse 返回状态说明

用于定义方法每个的返回状态说明

   @ApiResponse：每个参数的说明
       code：数字，例如408
       message：信息，例如"没有携带token"
       response：抛出异常的类
@ApiResponse(code = 408, message = "没有携带token")

@ApiResponses 方法返回对象的说明

用于定义方法返回整个对象的说明

	@ApiResponses({
   	@ApiResponse(code = 408, message = "没有携带token"),
   	@ApiResponse(code = 200, message = "请求成功")
   })