org.nutz.plugins.apidoc.annotation

注释类型 Api

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

供ApidocUrlMapping读取

作者:

wendal

另请参阅:

ApidocUrlMapping.wendal.nutzbook.mvc.ExpUrlMapping

必需元素概要

所需元素

限定符和类型	必需的元素和说明
String	name 给个名字行不行!!

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	author 作者信息
String	description 长文本描述信息
ReturnKey[]	fail 失败返回
ApiMatchMode	match 过滤模式,默认为ALL
ReturnKey[]	ok 成功返回
ApiParam[]	params 参数列表

元素详细资料

name

public abstract String name

给个名字行不行!!

返回:

模块或入口方法的可读名称

description

public abstract String description

长文本描述信息

返回:

描述一下这个方法大概是干啥的

默认值:

""

params

public abstract ApiParam[] params

参数列表

默认值:

{}

ok

public abstract ReturnKey[] ok

成功返回

返回:

默认值:

{}

fail

public abstract ReturnKey[] fail

失败返回

返回:

默认值:

{}

author

public abstract String author

作者信息

默认值:

""

match

public abstract ApiMatchMode match

过滤模式,默认为ALL

默认值:

org.nutz.plugins.apidoc.annotation.ApiMatchMode.ALL