io.jboot.apidoc.annotation

注释类型 Api

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Api

必需元素概要

所需元素

限定符和类型	必需的元素和说明
String	value 文档标题

可选元素概要

可选元素

限定符和类型	可选元素和说明
Class<?>[]	collect 其他类的方法也汇总到此 API 文档里来
String	filePath 生成的文件路径，不配置的情况下，默认为 Controller 的 mapping 转换，例如 mapping 为：/abc/aaa 转为为 abc_aaa。
String	notes 文档描述
int	orderNo 生成文档的排序

元素详细资料

value

public abstract String value

文档标题

返回:

notes

public abstract String notes

文档描述

返回:

默认值:

""

filePath

public abstract String filePath

生成的文件路径，不配置的情况下，默认为 Controller 的 mapping 转换，例如 mapping 为：/abc/aaa 转为为 abc_aaa。 / 转为为 index。

返回:

默认值:

""

collect

public abstract Class<?>[] collect

其他类的方法也汇总到此 API 文档里来

返回:

默认值:

{}

orderNo

public abstract int orderNo

生成文档的排序

返回:

默认值:

0