org.hoyi.microservice.api.anno

注释类型 Apidoc

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

用于生成API文档的注解.

作者:

sam

可选元素概要

可选元素

限定符和类型	可选元素和说明
boolean	CanReq 是否能接受请求
String	Cates 分类,相当于二级模块分类.
ApiEntityPara[]	entityparas 实体类当作参数.
String	Module 模块.
String	Notes 相当于当前API的介绍.
ApiPara[]	paras 接口的所有参数.
String	ReqType POST,GET,DELETE??
String	ReqURL 请求的路径
ApiPara[]	response 返回字段的说明.
String	retValue 返回值，有的返回String ,有的返回void, 有的返回JsonModel.

元素详细资料

Module

public abstract String Module

模块.

默认值:

""

Cates

public abstract String Cates

分类,相当于二级模块分类.

默认值:

""

Notes

public abstract String Notes

相当于当前API的介绍.

默认值:

""

ReqURL

public abstract String ReqURL

请求的路径

默认值:

""

ReqType

public abstract String ReqType

POST,GET,DELETE??

默认值:

"POST"

retValue

public abstract String retValue

返回值，有的返回String ,有的返回void, 有的返回JsonModel.

默认值:

"void"

CanReq

public abstract boolean CanReq

是否能接受请求

默认值:

false

paras

public abstract ApiPara[] paras

接口的所有参数.

默认值:

{}

entityparas

public abstract ApiEntityPara[] entityparas

实体类当作参数.

返回:

value

默认值:

{}

response

public abstract ApiPara[] response

返回字段的说明.

返回:

value

默认值:

{}