com.github.liuanxin.api.annotation

注释类型 ApiParam

@Target(value={PARAMETER,FIELD})
 @Retention(value=RUNTIME)
 @Documented
public @interface ApiParam

必需元素概要

所需元素

限定符和类型	必需的元素和说明
java.lang.String	value

可选元素概要

可选元素

限定符和类型	可选元素和说明
java.lang.String	dataType when customize type comment, use this(example for Enum)
java.lang.String	example
boolean	must
java.lang.String	name param name, if set will ignore paramName
ParamType	paramType
boolean	textarea in html, true will be textarea, default was input.

元素详细资料

value

public abstract java.lang.String value

name

public abstract java.lang.String name

param name, if set will ignore paramName

默认值:

""

dataType

public abstract java.lang.String dataType

when customize type comment, use this(example for Enum)

默认值:

""

paramType

public abstract ParamType paramType

默认值:

com.github.liuanxin.api.annotation.ParamType.Query

example

public abstract java.lang.String example

默认值:

""

must

public abstract boolean must

默认值:

false

textarea

public abstract boolean textarea

in html, true will be textarea, default was input.

默认值:

false