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)
全栈程序员-站长的头像全栈程序员-站长

相关推荐

  • 批处理for循环中截取字符串_bat文件输出字符串

    批处理for循环中截取字符串_bat文件输出字符串http://www.jb51.net/article/50354.htm先把FOR的变量全部列出来:     ~I           -删除任何引号(“),扩展%I     %~fI         -将%I扩展到一个完全合格的路径名     %~dI         -仅将%I扩展到一个驱动器号     %~pI     

    2022年10月12日
  • Petshop4学习

    Petshop4学习Petshop4的研究分析:http://blog.csdn.net/sjklove/archive/2006/11/10/1377405.aspx1.项目概述与架构分析微软刚推出了基于ASP.NET2.0下的PetShop4,该版本有了一个全新的用户界面。是研究ASP.NET2.0的好范例啊,大家都知道,一直以来,在.NET和Java之间争论不休,到底使用哪个平台开发的企业级应用性…

    2022年10月17日
  • WebGame开发过程中的一些思考和总结

    WebGame开发过程中的一些思考和总结WebGame如今已经很火,市场也很大,盛大和腾讯都已经看中这一块市场。我自己也在做这方面的研发,总结和思考一些问题。

    2022年5月29日
  • 空间向量和矩阵_线性无关的函数内积为零吗

    空间向量和矩阵_线性无关的函数内积为零吗文章目录前言一、集合的基本概念二、向量空间1.运算规则和定理2.RnR^nRn和CnC^nCn三、实内积空间1.内积2.范数四、复内积空间五、线性映射前言本文学习过程来源是《矩阵分析与应用-张贤达》一书.可以通过z-lib下载.线性空间是某一类事物在矩阵代数里的一个抽象的集合表示,线性映射或线性变换则反映线性空间中元素间最基本的线性关系.上面这句话出自书中第14页开头,读下来第一感觉就是云里雾里,毕竟出现了新的名称.对于线性空间可以简单的把它理解为几何空间(实际上不仅仅

    2022年10月21日
  • 栈和队列讲解_栈和队列的优缺点

    栈和队列讲解_栈和队列的优缺点目录1、栈(1)栈的概念及结构(2)栈的实现2、队列(1)队列的概念及结构(2)队列的实现前言:栈和队列是在顺序表和链表的延伸,如果前面的顺序表和链表你已经掌握了的话,栈和队列对你来说应该就是小菜一碟了。1、栈(1)栈的概念及结构栈:一种特殊的线性表,其只允许在固定的一端进行插入和删除元素操作。进行数据插入和删除操作的一端称为栈顶,另一端称为栈底。栈中的数据元素遵守后进先出LIFO(LastInFirstOut)的原则。压栈:栈的插入操作叫做进栈/压栈..

    2022年10月30日
  • JavaScript 基本知识

    JavaScript 基本知识bilibiliJS视频链接:https://www.bilibili.com/video/BV1W54y1J7Ed?p=2&spm_id_from=pageDrivervscode配置html:https://blog.csdn.net/caohongxing/article/details/108632859目录JS来源JavaScript核心由三部分组成书写位置:行内式,内嵌式,外链式变量:var准备一个容器,变量名有规格且区分大小写JS中的数据:基本数据类型和引用数据类型.

    2022年10月20日

发表回复

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

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