SpringBoot中的@ApiModelProperty注解作用

 更新时间:2022年01月10日 15:22:54   作者:象在舞  
这篇文章主要介绍了SpringBoot中的@ApiModelProperty注解作用,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教。

@ApiModelProperty注解作用

@ApiModelProperty()注解用于方法、字段,表示对model属性的说明或者数据操作更改,以下是它的源码:

 
  // IntelliJ API Decompiler stub source generated from a class file
  // Implementation of methods is not available 
package io.swagger.annotations; 
@java.lang.annotation.Target({java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.FIELD})
@java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
public @interface ApiModelProperty {
    java.lang.String value() default ""; 
    java.lang.String name() default ""; 
    java.lang.String allowableValues() default ""; 
    java.lang.String access() default ""; 
    java.lang.String notes() default ""; 
    java.lang.String dataType() default ""; 
    boolean required() default false; 
    int position() default 0; 
    boolean hidden() default false; 
    java.lang.String example() default "";
 
    /**
     * @deprecated
     */
    @java.lang.Deprecated
    boolean readOnly() default false; 
    io.swagger.annotations.ApiModelProperty.AccessMode accessMode() default io.swagger.annotations.ApiModelProperty.AccessMode.AUTO; 
    java.lang.String reference() default ""; 
    boolean allowEmptyValue() default false; 
    io.swagger.annotations.Extension[] extensions() default {@io.swagger.annotations.Extension(properties = {@io.swagger.annotations.ExtensionProperty(name = "", value = "")})}; 
    static enum AccessMode {
        AUTO, READ_ONLY, READ_WRITE; 
        private AccessMode() { /* compiled code */ }
    }
}

主要字段说明

  • value:字段说明
  • name:重写属性名字
  • dataType:重写属性类型
  • required:是否必须,默认false
  • example:举例
  • hidden:隐藏

举个简单的例子

@ApiModel(value="user", description="users")
public class UserVO implements Serializable{    
    private static final long serialVersionUID = 1L;    
     @ApiModelProperty(value="用户名", name="username", example="xzw")
     private String username;     
     @ApiModelProperty(value="状态", name="status", required=true)
      private Integer status;
      private String pwd;
      private String nName;
      private Integer flag;
 
      @ApiModelProperty(value="grade数组", hidden=true)
      private String[] grades;
      private List<String> gradeList;
}

@ApiModelProperty()失效

解决方法

可以把

@ApiModelProperty(value= "id")

替换成

@ApiModelProperty(example = "id")

即可~

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 解决swagger2中@ApiResponse的response不起作用

    解决swagger2中@ApiResponse的response不起作用

    这篇文章主要介绍了解决swagger2中@ApiResponse的response不起作用问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • 用Maven打成可执行jar,包含maven依赖,本地依赖的操作

    用Maven打成可执行jar,包含maven依赖,本地依赖的操作

    这篇文章主要介绍了用Maven打成可执行jar,包含maven依赖,本地依赖的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • Java实现打印二叉树所有路径的方法

    Java实现打印二叉树所有路径的方法

    这篇文章主要介绍了Java实现打印二叉树所有路径的方法,涉及java二叉树遍历与运算相关操作技巧,需要的朋友可以参考下
    2018-02-02
  • Java技术汇总

    Java技术汇总

    本篇文章主要对Java基本知识点和技术点的一些看法和介绍,具有很好的参考价值。下面跟着小编一起来看下吧
    2017-03-03
  • JAVASE系统实现抽卡功能

    JAVASE系统实现抽卡功能

    这篇文章主要为大家详细介绍了JAVASE系统实现抽卡功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-11-11
  • SpringMVC处理multipart请求的示例代码

    SpringMVC处理multipart请求的示例代码

    本篇文章主要介绍了SpringMVC处理multipart请求的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • spring boot 添加admin监控的方法

    spring boot 添加admin监控的方法

    这篇文章主要介绍了spring boot 添加admin监控的相关知识,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2018-02-02
  • 浅谈HashMap、HashTable的key和value是否可为null

    浅谈HashMap、HashTable的key和value是否可为null

    这篇文章主要介绍了浅谈HashMap、HashTable的key和value是否可为null,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • JAVA动态代理模式(从现实生活角度理解代码原理)

    JAVA动态代理模式(从现实生活角度理解代码原理)

    本文主要介绍了JAVA动态代理模式(从现实生活角度理解代码原理)的相关知识。具有很好的参考价值。下面跟着小编一起来看下吧
    2017-03-03
  • Java实现简单的万年历

    Java实现简单的万年历

    这篇文章主要为大家详细介绍了Java实现简单的万年历,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-04-04

最新评论