- 类注解
- @Api(类注解)
- value
表示类的链接地址,访问此类的URL中需要加/,必填。
- description
表示类描述信息,选填。
- produces
表示返回数据结构,选填。
- 方法注解
- @ApiOperation(方法注释)
- value
表示访问此方法的链接地址,必填。
- notes
表示方法的描述,选填。
- httpMethod
表示请求方式,选填。
- consumes
表示请求数据结构,选填。
- produces
表示响应数据结构,选填。
- @ApiImplicitParams(参数注释集)
- ApiImplicitParam(参数注释)
- paramType
表示参数位置,可填值有body、head、path、query、form。
-
name
- paramType
- ApiImplicitParam(参数注释)
表示参数名。
- required
表示是否必填。
- value
表示参数描述。
- dataType
表示参数类型。
- @ApiResponses(响应信息注释集)
- @ApiResponse(响应信息注释)
- code
表示响应码。
-
message
- code
- @ApiResponse(响应信息注释)
表示响应码解释。
- response
表示返回类。
- 实体类注解
- @ApiModel(实体类注解)
- value
表示对象名称。
-
description
表示描述。
- value
-
@ApiModelProperty(实体类字段注释)
-
value
-
表示字段名。
- required
表示是否必填。