com.github.ddm4j.api.document.annotation

注释类型 ApiParam

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Repeatable(value=ApiParams.class)
public @interface ApiParam

用于描述 字段,配置校验等信息

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	describe 示例说明，会覆盖 ApiField 的说明
String	field 字段，多层使用 a.b 的方式。
int	max 数字类型判断值,字符串判断长度,设置的值不能是：2147483647
String	message 校验错误消息，使用 ${key} 读取配置文件中的配置; 默认： ${default}， 可以配置文件中重写; required: 不能为空; regexp: 非法数据; max: 超过限制; min: 低于限制;
int	min 数字类型判断值,字符串判断长度,设置的值不能是：-2147483648
String	regexp 正则校验: 使用 ${key} 方式，读取配置文件中的正则校验规则，自带以下规则： ${email} 电子邮件、 ${phone} 手机号(中国)、 ${telephone} 固定电话(中国)、 ${date} 日期：yyyy-MM-dd、 ${date_M} 日期：yyyy-MM、 ${date_Md} 日期：MM-dd、 ${dateTime} 日期：yyyy-MM-dd HH:mm:ss、 ${dateTime_Hm} 日期：yyyy-MM-dd HH:mm、 ${dateTime_H} 日期：yyyy-MM-dd HH、 ${time} 日期：HH:mm:ss、 ${time_Hm} 日期：HH:mm、 ${time_ms} 日期：mm:ss、 以上规则，可在配置文件中重写。
boolean	required 是否必须，默认 否
String	value 字段，多层请用点， 如 a.b

元素详细资料

value

@AliasFor(value="field")
public abstract String value

字段，多层请用点， 如 a.b

返回:

字段

默认值:

""

field

@AliasFor(value="value")
public abstract String field

字段，多层使用 a.b 的方式。

返回:

字段名

默认值:

""

required

public abstract boolean required

是否必须，默认 否

返回:

是否必须

默认值:

false

regexp

public abstract String regexp

正则校验: 使用 ${key} 方式，读取配置文件中的正则校验规则，自带以下规则： ${email} 电子邮件、 ${phone} 手机号(中国)、 ${telephone} 固定电话(中国)、 ${date} 日期：yyyy-MM-dd、 ${date_M} 日期：yyyy-MM、 ${date_Md} 日期：MM-dd、 ${dateTime} 日期：yyyy-MM-dd HH:mm:ss、 ${dateTime_Hm} 日期：yyyy-MM-dd HH:mm、 ${dateTime_H} 日期：yyyy-MM-dd HH、 ${time} 日期：HH:mm:ss、 ${time_Hm} 日期：HH:mm、 ${time_ms} 日期：mm:ss、 以上规则，可在配置文件中重写。

返回:

正则校验

默认值:

""

min

public abstract int min

数字类型判断值,字符串判断长度,设置的值不能是：-2147483648

返回:

最小值

默认值:

-2147483648

max

public abstract int max

数字类型判断值,字符串判断长度,设置的值不能是：2147483647

返回:

最大值

默认值:

2147483647

describe

public abstract String describe

示例说明，会覆盖 ApiField 的说明

返回:

示例说明

默认值:

""

message

public abstract String message

校验错误消息，使用 ${key} 读取配置文件中的配置; 默认： ${default}， 可以配置文件中重写; required: 不能为空; regexp: 非法数据; max: 超过限制; min: 低于限制;

返回:

校验错误消息

默认值:

""