bee.cloud.service.core.annotation

注释类型 ApiParam

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

必需元素概要

所需元素

限定符和类型	必需的元素和说明
java.lang.String	name 参数名称

可选元素概要

可选元素

限定符和类型	可选元素和说明
java.lang.String	dict 数据字典
boolean	encrypt 是否加密传输，如果设置为加密传输，将不再接收明文内容
int	length 参数内容最大长度，默认为0表示不限制长度，数字、日期类型不受限，自动判断
java.lang.String	memo 参数描述
boolean	required 是否必填参数，默认为false-非必填
boolean	share 共享参数，默认为false不共享
java.lang.String	title 参数标题，默认为参数名称
QEnum.QType	type 参数类型，默认为字符串

元素详细资料

name

public abstract java.lang.String name

参数名称

返回:

-

title

public abstract java.lang.String title

参数标题，默认为参数名称

返回:

-

默认值:

""

type

public abstract QEnum.QType type

参数类型，默认为字符串

返回:

-

默认值:

bee.cloud.engine.config.sqlmap.QEnum.QType.CHARACTER

length

public abstract int length

参数内容最大长度，默认为0表示不限制长度，数字、日期类型不受限，自动判断

返回:

-

默认值:

0

memo

public abstract java.lang.String memo

参数描述

返回:

-

默认值:

""

dict

public abstract java.lang.String dict

数据字典

返回:

-

默认值:

""

share

public abstract boolean share

共享参数，默认为false不共享

返回:

-

默认值:

false

required

public abstract boolean required

是否必填参数，默认为false-非必填

返回:

-

默认值:

false

encrypt

public abstract boolean encrypt

是否加密传输，如果设置为加密传输，将不再接收明文内容

返回:

-

默认值:

false