基本的注解走起吧!!!
@Api:用在请求的类上,表示对类的说明
tags:说明该类的作用
description:可描述描述该类作用
@Api(tags = "系统:系统授权接口")
@Slf4j
@RestController
@RequestMapping("/auth")
public class AuthController {
@ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
header | 请求参数的获取:@RequestHeader 参数在request headers 里边提交 |
query | 请求参数的获取:@RequestParam 直接跟参数完成自动映射赋值 |
path | 请求参数的获取:@PathVariable 以地址的形式提交数据 |
body | 以流的形式提交 仅支持POST |
form | 以form表单的形式提交 仅支持POST |
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
@ApiImplicitParams({
@ApiImplicitParam(name = "category", value = "模板类别",paramType = "query"),
@ApiImplicitParam(name = "ptype", value = "适用项目类别",paramType = "query"),
@ApiImplicitParam(name = "pnode", value = "适用项目类别", paramType = "query"),
@ApiImplicitParam(name = "tname", value = "模板名称", paramType = "query"),
})
public ResultVo getTemp(Message msg){}
@ApiModel:
用于类,表示对类进行说明,用于参数用实体类接收;
@ApiModelProperty:
用于方法,字段 ,表示对model属性的说明或者数据操作更改
@Data
@ApiModel(description = "日志筛选条件实体")
public class LogCondition {
@ApiModelProperty(value = "父模块", notes = "筛选条件+日志所属父模块")
private String module;//模块
@ApiModelProperty(value = "子模块", notes = "筛选条件+日志所属子模块")
private String submodule;//子模块
@ApiModelProperty(value = "动作", notes = "筛选条件+动作")
private String action;//动作
@ApiModelProperty(value = "操作者真实姓名", notes = "筛选条件+操作者真实姓名")
private String realName;//操作者真实姓名
@ApiModelProperty(value = "操作开始时间", notes = "筛选条件+操作开始时间")
private String startTime;//操作时间
@ApiModelProperty(value = "操作结束时间", notes = "筛选条件+操作结束时间")
private String endTime;//操作时间
@ApiModelProperty(value = "备注", notes = "筛选+条件备注")
private String remark;//备注
}
@ApiOperation:
用于方法,表示一个http请求的操作 。
@ApiOperation("获取验证码")
@GetMapping(value = "/code")
public ResponseEntity<Object> getCode(){}
@ApiResponse:
用于方法,描述操作的可能响应。
@ApiResponses:
用于方法,一个允许多个ApiResponse对象列表的包装器,表示一组响应
@ApiResponses(value = {
@ApiResponse(code = 1004, message = "参数缺失"),
@ApiResponse(code = 5001, message = "数据未找到"),
@ApiResponse(code = 5004, message = "数据更新失败"),
@ApiResponse(code = 5005, message = "数据写入失败"),
@ApiResponse(code = 5006, message = "数据删除失败"),
})
swagger github 地址:https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X