com.github.ddm4j.api.document.annotation

注释类型 ApiHeadParam

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
public @interface ApiHeadParam

限制只能用于类和方法上，请求头参数说明

必需元素概要

所需元素

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

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	describe 示例说明
boolean	required 是否必须，默认 是
String	type 数据类型，默认 String

元素详细资料

value

public abstract String value

字段名

返回:

字段名

type

public abstract String type

数据类型，默认 String

返回:

数据类型

默认值:

"String"

required

public abstract boolean required

是否必须，默认 是

返回:

是否必须

默认值:

true

describe

public abstract String describe

示例说明

返回:

示例说明

默认值:

""