io.swagger.solon.annotation

注释类型 ApiResProperty

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ApiResProperty

接口返回参数

从以下版本开始:

2.3

必需元素概要

所需元素

限定符和类型	必需的元素和说明
java.lang.String	name 字段名,默认取参数名称
java.lang.String	value 字段描述

可选元素概要

可选元素

限定符和类型	可选元素和说明
boolean	allowMultiple 参数类型为数组
java.lang.String	dataType 字段类型
java.lang.Class<?>	dataTypeClass 返回对象
java.lang.String	example 示例值
java.lang.String[]	exampleEnum 示例值 枚举
java.lang.String	format 格式化

元素详细资料

name

public abstract java.lang.String name

字段名,默认取参数名称

value

public abstract java.lang.String value

字段描述

dataType

public abstract java.lang.String dataType

字段类型

默认值:

""

format

public abstract java.lang.String format

格式化

默认值:

""

example

public abstract java.lang.String example

示例值

默认值:

""

exampleEnum

public abstract java.lang.String[] exampleEnum

示例值 枚举

默认值:

{}

allowMultiple

public abstract boolean allowMultiple

参数类型为数组

默认值:

false

dataTypeClass

public abstract java.lang.Class<?> dataTypeClass

返回对象

默认值:

java.lang.Void.class