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


相关推荐

  • 僵死进程及exec

    僵死进程及exec一.僵死进程僵死进程及处理方法(1)僵死进程概念:子进程先于父进程结束,父进程没有调用wait获取子进程退出码。(2)如何处理僵死进程:父进程通过调用wait()完成。(3)Init进

    2022年7月1日
    27
  • 如何在阿里云服务器Centos 7中部署定时签到python脚本

    如何在阿里云服务器Centos 7中部署定时签到python脚本

    2021年10月3日
    53
  • Hybrid App 开发快速指南[通俗易懂]

    Hybrid App 开发快速指南[通俗易懂]课程背景混合应用相对于原生应用而言,是原生应用和Web应用的结合体。过去几年,混合应用开发的各种利弊已得到充分的讨论和验证。关于混合应用是什么、为什么使用的问题,相信大家都有自己的答案,但如何开发混合应用,从现有资料中却很难找到一个系统、全面的回答。刚上手或准备上手混合应用的开发者,经常苦于没有一套经过验证的最佳实践来指导开发,在开发的各个阶段往往遇到各种问题:如何选型?如何架构前端…

    2022年4月19日
    72
  • nextSibling 和nextElementSibling

    nextSibling 和nextElementSibling在使用DOM过程中发现一个问题:使用nextSibling属性返回指定节点之后紧跟的节点,在相同的树层级中。被返回的节点以Node对象返回。nextSibling属性与nextElement

    2022年7月4日
    22
  • js获取当前年月日时分秒_js获取当前系统时间年月日

    js获取当前年月日时分秒_js获取当前系统时间年月日vardate=newDate();date.getYear();//获取当前年份(2位)date.getFullYear();//获取完整的年份(4位)date.getMonth();//获取当前月份(0-11,0代表1月)date.getDate();//获取当前日(1-31)date.getDay();//获取当前星期X(0-6,0代表星期天)date.getT…

    2026年3月2日
    5
  • java学习(分布式架构)

    java学习(分布式架构)声明 版权所有 欢迎转载 请勿用于商业用途 联系信箱 开头的话 架构多半和业务关联在一起 如果只是简单的图书管理系统 选课系统或者什么简单的财务系统 用不着分布式 只有大型公司 高并发的业务才需要分布式的帮助 当然 架构本身要和业务模型紧密配合才能发挥作用 很长一段时间 java 都是最流行的编程语言 我想 一方面

    2026年3月19日
    2

发表回复

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

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