io.swagger.solon.annotation

Annotation Type ApiResProperty

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

接口返回参数

Since:

2.3

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name 字段名,默认取参数名称
String	value 字段描述

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowMultiple 参数类型为数组
String	dataType 字段类型
Class<?>	dataTypeClass 返回对象
String	example 示例值
String[]	exampleEnum 示例值 枚举
String	format 格式化

Element Detail

name

public abstract String name

字段名,默认取参数名称

value

public abstract String value

字段描述

dataType

public abstract String dataType

字段类型

Default:

""

format

public abstract String format

格式化

Default:

""

example

public abstract String example

示例值

Default:

""

exampleEnum

public abstract String[] exampleEnum

示例值 枚举

Default:

{}

allowMultiple

public abstract boolean allowMultiple

参数类型为数组

Default:

false

dataTypeClass

public abstract Class<?> dataTypeClass

返回对象

Default:

java.lang.Void.class