Swagger3.0接口文档案例实战进阶
##Swagger3.x对象注解ApiModel讲解
简介:讲解Swagger3.x对象注解ApiModel讲解
-
APiModel和ApiModelProperty对象注解介绍
-
@ApiModel()
- 用于类 表示对类进行说明,用于参数用实体类接收,value–表示对象名,description–描述
- 这种一般用在post创建的时候,使用对象提交这样的场景
-
@ApiModelProperty()
- 用于方法,字段; 表示对model属性的说明或者数据操作更改
- value–字段说明
- name–重写属性名字
- dataType–重写属性类型
- required–是否必填
- example–举例说明
- hidden–隐藏
-
SaveUserRequest.java 我是就是VO类!!!!!!!
@Data
@ApiModel("用户基本信息")
public class SaveUserRequest {
private int age;
private String pwd;
@ApiModelProperty(value ="【必填】邮箱",required = true)
private String email;
@ApiModelProperty("【必填】手机号")
private String phone;
@ApiModelProperty(value="创建时间")
private Date createTime;
}