@ApiModel注解与@ApiModelProperty注解

这篇具有很好参考价值的文章主要介绍了@ApiModel注解与@ApiModelProperty注解。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、@ApiModel注解与@ApiModelProperty注解


资料来源: https://juejin.cn/post/7109835493952454693

1.1 初了解


@ApiModel注解是用在接口相关的实体类上的注解,它主要是用来对使用该注解的接口相关的实体类添加额外的描述信息常常和@ApiModelProperty注解配合使用

@ApiModelProperty注解则是作用在接口相关实体类的属性(字段)上的注解,用来对具体的接口相关实体类中的参数添加额外的描述信息,除了可以和 @ApiModel 注解关联使用,也会单独拿出来用。

作用域不同,@ApiModel作用在类上,@ApiModel作用来属性上

1.2 Maven坐标


导入swagger的依赖:

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.5.13</version>
</dependency>

1.3 ApiModel


主要的属性有value属性和description属性

  • value属性就是对所需要特别说明的接口相关实体类进行描述。

具体使用就如上面的例子一样,如果不使用value时,默认值就是实体类的名称,所以除非有特殊说明或者实体类不清晰,否则直接使用默认值即可。

  • description属性就是对所需要特别说明的接口相关实体类进行较长的描述。

比如上面的例子,如果想对用户实体添加必要的描述信息,可以如下所示:

@ApiModel(value="用户实体类,用户相关字段", description="用户实体中包含用户相关的所有业务字段,主要字段有姓名、年龄、性别,用于登录使用")
publicclassUser{
}

1.4 ApiModelProperty


属性:value、name、required 、hidden、allowEmptyValue

@Data
@ApiModel(value="用户实体类,用户相关字段", description="用户实体中包含用户相关的所有业务字段,主要字段有姓名、年龄、性别,用于登录使用")
publicclassUser {
​
    @ApiModelProperty("主键")
    privateIntegerid;
​
    @ApiModelProperty("姓名")
    privateStringname;
}

1.4.1 value属性

对实体类中的字段进行描述和补充说明,解释该字段代表什么意思。

理解为它就是一个注释的作用,方便清楚字段的含义。

@ApiModelProperty(
    value="是否成功:200-成功,其他失败",
    required=true,
    example="200"
)
private String code;

1.4.2 name属性

name属性即重写该属性名字,比如上述例子,name可以这样使用

@ApiModelProperty(value="user表主键Id",name="id")
   private Integer id;

1.4.3 required 属性

required属性就是用来描述实体中的参数字段是否必传,默认false,如果使用true,则该字段后面会有一个红色的星号

@ApiModelProperty(value="user表主键Id",name="id",required=true)
   private Integer id;
   
   @ApiModelProperty(required=false)//或者不行就是默认false
   private Integer age;
​

1.4.4 hidden属性

用来描述实体中参数字段是否显示在Swagger界面中,默认也是false,true表示隐藏。

   @ApiModelProperty(hidden=true)
   private String address;

1.4.5 allowEmptyValue属性

用来描述实体参数的值是否可以为空值。在 ApiModelProperty 注解中直接声明 allowEmptyValue属性的值即可,如果不声明该属性,则默认为false,即字段参数的值不可以为空。

使得master字段声明其值可以为空,即在参数传递时可以不填充值

  @ApiModelProperty(allowEmptyValue=true)
   private String master;

1.4.6 example属性

@ApiModelProperty(
    value="是否成功:200-成功,其他失败",
    required=true,
    example="200"
)
private String code;

1.4.7 dataType属性

表示的是字段的类型文章来源地址https://www.toymoban.com/news/detail-439310.html

@ApiModelProperty(required=false,dataType="int")//或者不写就是默认false
   private Integer age;

到了这里,关于@ApiModel注解与@ApiModelProperty注解的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Java|注解之定义注解

    Java语言使用 @interface 语法来定义注解( Annotation ),它的格式如下:  注解的参数类似无参数方法,可以用 default 设定一个默认值(强烈推荐)。最常用的参数应当命名为 value 。 元注解 有一些注解可以修饰其他注解,这些注解就称为元注解 (meta annotation)。Java标准库已经

    2024年02月05日
    浏览(45)
  • 11Spring IoC注解式开发(下)(负责注入的注解/全注解开发)

    负责注入的注解,常见的包括四个: @Value @Autowired @Qualifier @Resource 当属性的类型是简单类型时,可以使用@Value注解进行注入。 @Value注解可以出现在属性上、setter方法上、以及构造方法的形参上, 方便起见,一般直接作用在属性上. 配置文件开启包扫描: 测试程序: 三种方法都可

    2024年01月16日
    浏览(47)
  • Spring 注解 和SpringMVC注解

    Spring和Spring MVC是两个紧密相关但又不同的框架,它们都使用一系列注解来简化开发。以下是Spring和Spring MVC中一些常用的注解: ### Spring 注解: 1. **`@Component`:**    - 用于将类标记为Spring容器中的组件,由Spring自动扫描并进行管理。    - 具体的派生注解有`@Service`、`@Reposit

    2024年01月23日
    浏览(54)
  • 【Java基础】注解——自定义注解

    Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。 比如我们常见的@Override和@Deprecated都是注解,注解可以加在类、方法、成员变量等上面,类似于给他们“ 打标签 \\\"。 public @interface 注解名{} 看起来和定义接口很相似只是多了一个@符号 接口: public interface 接口名

    2024年02月03日
    浏览(44)
  • springboot注解之@ConfigurationProperties注解

    目录 一 . 什么是@ConfigurationProperties注解 二 . @ConfigurationProperties的参数解释 三  举例说明  在 SpringBoot 中,当想需要获取到配置文件数据时,除了可以用 Spring 自带的 @Value 注解外,SpringBoot 还提供了一种更加方便的方式:@ConfigurationProperties。只要在 Bean 上添加上了这个注解,

    2024年02月01日
    浏览(29)
  • Java注解——@Override注解(详解1)

    1、注解: 注解是 JDK 1.5 的特性 注解是给编译器或 JVM 看的,编译器或 JVM 可以根据注解来完成相应的功能。 或者叫注释类型,英文是:Annotation 注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。 注解的语法格式: 【修饰符列表】 @interface 注解类型名{ } publ

    2024年02月03日
    浏览(44)
  • Java中的注解,自定义注解

    框架 = 注解 + 反射 + 设计模式 注解( Annotation )是从JDK5.0开始引入,以“@注解名”在代码中存在。 Annotation 可以像修饰符一样被使用,可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明。还可以添加一些参数值,这些信息被保存在 Annotation 的 “name=valu

    2023年04月16日
    浏览(103)
  • java 元注解||自定义注解的使用

    1. @Retention注解 指定了标记的注解如何存储: RetentionPolicy.SOURCE,标记的注解仅保留在源代码级别,并被编译器忽略。 RetentionPolicy.CLASS,标记的注解在编译时由编译器保留,但被Java虚拟机(JVM)忽略。 RetentionPolicy.RUNTIME,标记的注解由JVM保留,以便运行时环境可以使用。 2. @Do

    2024年02月16日
    浏览(36)
  • JAVA学习-注解.基于注解的单元测试

            基于注解的单元测试是一种使用注解来简化和增强测试代码编写和执行的方法。在Java中,有多个基于注解的单元测试框架可供选择,包括JUnit、TestNG等。下面将对几个常见的基于注解的单元测试框架进行概述,并介绍它们的特点、使用方法以及与其他框架的比较。

    2024年04月28日
    浏览(34)
  • 【Python】类型注解 ⑤ ( Union 联合类型注解 | Union 联合类型语法 | 普通 / 容器 变量设置 Union 联合类型注解 | 函数设置 Union 联合类型注解 )

    对 list 列表 或 dict 字典 类型 设置 类型注解 , 如果 list 列表中的元素都是 int 类型 , dict 字典 中的 键值对 , 键 Key 类型是 str 字符串类型 , 值 Value 的类型是 int 数字类型 , 那么 , 可以写成下面的形式 ; 假如 list 列表 中的 元素类型不是 int 类型 , 而是 str 类型 或 int 类型 , 如下

    2024年02月10日
    浏览(45)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包