SpringBoot中的@ApiModelProperty注解

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

大家好,又见面了,我是你们的朋友全栈君。

       @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;
}

 

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/129530.html原文链接:https://javaforall.net

(0)
上一篇 2022年4月14日 上午11:00
下一篇 2022年4月14日 上午11:00


相关推荐

  • WEB各种环境以及注意事项「建议收藏」

    WEB各种环境以及注意事项「建议收藏」WEB各种环境以及注意事项

    2022年4月22日
    87
  • CCproxy 设置代理服务器。

    CCproxy 设置代理服务器。CCproxy 设置代理服务器 通过代理服务器上网 出口 IP 就固定成代理服务器的 IP 设置安装比较简单 直接去 ccproxy 官网下载就行如果服务器是公网服务器 记得在设置 高级里面的网络中 把禁止局域网外用户访问给去掉转载于 https www cnblogs com zjypp p 3715665 html

    2026年3月26日
    2
  • Java基础–运行第一个Java程序HelloWorld

    Java基础–运行第一个Java程序HelloWorldjava 目前发行了很多版本 公司用的最多的是 1 8 的版本 相对而言会比较稳定 java 的其中一个特性 跨平台 可以在 windows linux macos 操作系统下运行 java 跨平台的原

    2026年3月18日
    2
  • SMP技术_sls技术最重要的是使用领域是

    SMP技术_sls技术最重要的是使用领域是SMP英文全称为SymmetricalMulti-Processing,意指“对称多处理”技术,是指在一个计算机上汇集了一组处理器—即多CPU,各CPU之间共享内存子系统以及总线结构。它是相对非对称多处理技术而言的、应用十分广泛的并行技术。在这种架构中,一台电脑不再由单个CPU组成,而同时由多个处理器运行操作系统的单一复本,并共享内存和一台计算机的其他资源。虽然同时使用多个CPU,但是从管理的角度来看,它们的表现就像一台单机一样。系统将任务队列对称地分布于多个CPU之上,从而极大地提高了整个系统的数据处理

    2025年7月14日
    5
  • 微观察|“龙虾热”背后的“冷思考”

    微观察|“龙虾热”背后的“冷思考”

    2026年3月17日
    3
  • java中的pojo是什么意思_java中的POJO是什么意思?

    java中的pojo是什么意思_java中的POJO是什么意思?簡單的Java對象(PlainOrdinaryJavaObjects)實際就是普通JavaBeans,使用POJO名稱是為了避免和EJB混淆起來,而且簡稱比較直接.其中有一些屬性及其gettersetter方法的類,有時可以作為valueobject或dto(DataTransformObject)來使用.當然,如果你有一個簡單的運算屬性也是可以的,但不允許有業務方法,也不能攜帶…

    2022年5月28日
    37

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号