快捷導(dǎo)航

SpringBoot中的@ApiModelProperty注解作用

更新時間：2022年01月10日 15:22:54 作者：象在舞

這篇文章主要介紹了SpringBoot中的@ApiModelProperty注解作用，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教。

@ApiModelProperty注解作用

@ApiModelProperty()注解用于方法、字段，表示對model屬性的說明或者數(shù)據(jù)操作更改，以下是它的源碼：

 
  // 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：是否必須，默認(rèn)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="狀態(tài)", name="status", required=true)
? ? ? private Integer status;
? ? ? private String pwd;
? ? ? private String nName;
? ? ? private Integer flag;
?
? ? ? @ApiModelProperty(value="grade數(shù)組", hidden=true)
? ? ? private String[] grades;
? ? ? private List<String> gradeList;
}