com.github.ddm4j.api.document.annotation

注释类型 ApiResponse

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface ApiResponse

只能用在 @ApiResponses 注解中，用于描述 返回值 字段

必需元素概要

所需元素

限定符和类型	必需的元素和说明
String	field 字段，多层请用点， 如 a.b

可选元素概要

可选元素

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

元素详细资料

field

public abstract String field

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

返回:

字段

required

public abstract boolean required

是否必须，默认 否

返回:

false

默认值:

false

describe

public abstract String describe

示例说明

返回:

描述

默认值:

""