cn.bestwu.apidoc.starter

类 ApiDoc

cn.bestwu.apidoc.starter.ApiDoc

public class ApiDoc

接口文档数据模型

字段概要

字段

限定符和类型	字段和说明
static ApiDoc	INSTANCE 接口文档数据模型

方法概要

限定符和类型	方法和说明
void	enable() 是否启用文档数据生成
java.lang.String	getAuthor() 开发者
java.lang.String	getDesc() 接口描述
boolean	getEnable() 是否启用文档数据生成
java.lang.String[]	getHeaderRequires() 请求头必填参数
java.lang.String[]	getHeaders() 请求头
java.lang.String	getModuleName() 模块
java.lang.String	getName() 接口名称
java.lang.String[]	getRequires() 必填参数
java.lang.String	getResource() 资源名称
java.lang.String	getSchema()
java.lang.String[]	getTableNames() 相关数据表名
void	headerRequires(java.lang.String headerRequire) 请求头必填参数
void	headers(java.lang.String header) 请求头
void	requires(java.lang.String require) 必填参数
void	setAuthor(java.lang.String p) 开发者
void	setDesc(java.lang.String p) 接口描述
void	setEnable(boolean p) 是否启用文档数据生成
void	setHeaderRequires(java.lang.String[] p) 请求头必填参数
void	setHeaders(java.lang.String[] p) 请求头
void	setModuleName(java.lang.String p) 模块
void	setName(java.lang.String p) 接口名称
void	setRequires(java.lang.String[] p) 必填参数
void	setResource(java.lang.String p) 资源名称
void	setSchema(java.lang.String p)
void	setTableNames(java.lang.String[] p) 相关数据表名
void	tableNames(java.lang.String tableName) 相关数据表名

字段详细资料

INSTANCE

public static ApiDoc INSTANCE

接口文档数据模型

方法详细资料

getModuleName

public java.lang.String getModuleName()

模块

setModuleName

public void setModuleName(java.lang.String p)

模块

getResource

public java.lang.String getResource()

资源名称

setResource

public void setResource(java.lang.String p)

资源名称

getName

public java.lang.String getName()

接口名称

setName

public void setName(java.lang.String p)

接口名称

getTableNames

public java.lang.String[] getTableNames()

相关数据表名

setTableNames

public void setTableNames(java.lang.String[] p)

相关数据表名

getRequires

public java.lang.String[] getRequires()

必填参数

setRequires

public void setRequires(java.lang.String[] p)

必填参数

getHeaderRequires

public java.lang.String[] getHeaderRequires()

请求头必填参数

setHeaderRequires

public void setHeaderRequires(java.lang.String[] p)

请求头必填参数

getHeaders

public java.lang.String[] getHeaders()

请求头

setHeaders

public void setHeaders(java.lang.String[] p)

请求头

getEnable

public boolean getEnable()

是否启用文档数据生成

setEnable

public void setEnable(boolean p)

是否启用文档数据生成

getAuthor

public java.lang.String getAuthor()

开发者

setAuthor

public void setAuthor(java.lang.String p)

开发者

getDesc

public java.lang.String getDesc()

接口描述

setDesc

public void setDesc(java.lang.String p)

接口描述

getSchema

public java.lang.String getSchema()

setSchema

public void setSchema(java.lang.String p)

tableNames

public void tableNames(java.lang.String tableName)

相关数据表名

requires

public void requires(java.lang.String require)

必填参数

headerRequires

public void headerRequires(java.lang.String headerRequire)

请求头必填参数

headers

public void headers(java.lang.String header)

请求头

enable

public void enable()

是否启用文档数据生成