@ApiModel
使用场景：在实体类上边使用，标记类时swagger的解析类
1.什么是Swagger OpenAPI规范（OpenAPI Specification 简称OAS）是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程，目前版本是V3.0，并且已经发布并开源在github上。
Swagger是符合OpenAPI规范的接口开发工具，支持从设计和文档到测试和部署的整个API生命周 期的开发
概述
提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省
属性名称
数据类型
默认值
说明
value
String
类名
为模型提供备用名称
description
String
" "
提供详细的描述
parent
void.class
为模型提供父类以允许描述继承关系
discriminatory
String
" "
支持模型继承和多态，使用鉴别器的字段的名称，可以断言需要使用哪个子类型
subTypes
{}
从此模型继承的子类型数组
reference
String
" "
指定对应类型定义的引用，覆盖指定的任何其他元数据
@ApiModelProperty
使用场景
使用在被 @ApiModel 注解的模型类的属性上
概述
添加和操作模型属性的数据
属性名称
数据类型
默认值
说明
value
String
" "
属性简要说明
name
String
" "
运行覆盖属性的名称。重写属性名称
required
boolean
" "
是否为必传参数,false:非必传参数; true:必传参数
example
String
" "
属性的示例值
代码示例:
@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "SysUserInfoResponse", description = "用户信息响应模型")
public class SysUserInfoResponse {
@ApiModelProperty(value = "用户ID", required = true, example = "")
private String userId;
@ApiModelProperty(value = "用户名", required = false, example = "")
private String userName;
@ApiModelProperty(value = "所属部门Id", required = false, example = "")
private String deptId;
@ApiModelProperty(value = "所属公司", required = false, example = "")
private String comId;
@ApiModelProperty(value = "所属公司名称", required = false, example = "")
private String comName;
@ApiModelProperty(value = "身份证号", required = false, example = "")
private String idnum;
@ApiModelProperty(value = "手机号", required = false, example = "")
private String phone;
@ApiModelProperty(value = "邮箱", required = false, example = "")
private String email;
}
最后
深知大多数初中级Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则近万的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！
因此收集整理了一份《Java开发全套学习资料》送给大家，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
小编已加密：aHR0cHM6Ly9kb2NzLnFxLmNvbS9kb2MvRFVrVm9aSGxQZUVsTlkwUnc==出于安全原因，我们把网站通过base64编码了，大家可以通过base64解码把网址获取下来。
推荐链接
您阅读本篇文章共花了：
发表评论