com.github.ddm4j.api.document.annotation

注释类型 ApiResponse

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Repeatable(value=ApiResponses.class)
public @interface ApiResponse

用于描述 返回值 字段

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	describe 示例说明，会覆盖 ApiField 的说明
String	field 字段，多层请用点， 如 a.b
boolean	required 是否一定会返回，默认 否
String	value 字段，多层请用点， 如 a.b

元素详细资料

value

@AliasFor(value="field")
public abstract String value

字段，多层请用点， 如 a.b

返回:

字段

默认值:

""

field

@AliasFor(value="value")
public abstract String field

字段，多层请用点， 如 a.b

返回:

字段

默认值:

""

required

public abstract boolean required

是否一定会返回，默认 否

返回:

false

默认值:

false

describe

public abstract String describe

示例说明，会覆盖 ApiField 的说明

返回:

描述

默认值:

""