com.github.ddm4j.api.document.annotation

注释类型 ApiResponseCode

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
public @interface ApiResponseCode

用户于配置Api返回code信息，只显示会返回的code信息

可选元素概要

可选元素

限定符和类型	可选元素和说明
String[]	cancel
String[]	codes
String	field
boolean	hide
String[]	value

元素详细资料

field

public abstract String field

返回:

返回值字段名

默认值:

""

hide

public abstract boolean hide

返回:

是隐藏这些code还是只显示这些code，默认 false,只显示被 codes 标识的

默认值:

false

value

@AliasFor(value="codes")
public abstract String[] value

返回:

只保留需要返回的 code，字段名，支持 * 匹配，只能于用前面或后面，如: *A , A* ;示例说明使用英文:隔开，如： SUCCESS:操作成功

默认值:

{}

codes

@AliasFor(value="value")
public abstract String[] codes

返回:

只保留需要返回的 code，字段名，支持 * 匹配，只能于用前面或后面，如: *A , A*;示例说明使用英文:隔开，如： SUCCESS:操作成功

默认值:

{}

cancel

public abstract String[] cancel

返回:

隐藏在配置文件中配置，统一返回的状态码，支持 * 匹配，只能于用前面或后面，如: *A , A*

默认值:

{}