com.github.ddm4j.api.document.annotation

注释类型 ApiParam

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface ApiParam

放在 @ApiParams中,用于描述 字段

必需元素概要

所需元素

限定符和类型	必需的元素和说明
String	field 字段

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	describe 示例说明
int	max 最大长度，数值为最大值
int	min 最小长度，数值为 最小值
String	reg 正则校验
boolean	required 是否必须，默认 否

元素详细资料

field

public abstract String field

字段

返回:

字段名

required

public abstract boolean required

是否必须，默认 否

返回:

是否必须

默认值:

false

reg

public abstract String reg

正则校验

返回:

正则校验

默认值:

""

min

public abstract int min

最小长度，数值为 最小值

返回:

最小值

默认值:

-2147483648

max

public abstract int max

最大长度，数值为最大值

返回:

最大值

默认值:

2147483647

describe

public abstract String describe

示例说明

返回:

示例说明

默认值:

""