跳过导航链接
A C D E F G H I K M P R S V 

A

addResourceHandlers(ResourceHandlerRegistry) - 类 中的方法com.github.ddm4j.api.document.config.ResourcesConfig
 
ApiController - com.github.ddm4j.api.document.annotation中的注释类型
Controller 说明
ApiDocumentConfig - com.github.ddm4j.api.document.config中的类
 
ApiDocumentConfig() - 类 的构造器com.github.ddm4j.api.document.config.ApiDocumentConfig
 
ApiDocumentController - com.github.ddm4j.api.document.controller中的类
 
ApiDocumentController() - 类 的构造器com.github.ddm4j.api.document.controller.ApiDocumentController
 
ApiField - com.github.ddm4j.api.document.annotation中的注释类型
字段说明
ApiHeader - com.github.ddm4j.api.document.annotation中的注释类型
PI请求头说明,限制只能用于Controller和方法上
ApiHeaderCancel - com.github.ddm4j.api.document.annotation中的注释类型
限制只能用于方法上,用来表示该方法请求不需要请求头
ApiHeadParam - com.github.ddm4j.api.document.annotation中的注释类型
限制只能用于类和方法上,请求头参数说明
ApiMethod - com.github.ddm4j.api.document.annotation中的注释类型
限制只能用于方法上,接口说明
ApiParam - com.github.ddm4j.api.document.annotation中的注释类型
放在 @ApiParams中,用于描述 字段
ApiParamCheck - com.github.ddm4j.api.document.check中的类
校验接口传递值
ApiParamCheck() - 类 的构造器com.github.ddm4j.api.document.check.ApiParamCheck
 
ApiParams - com.github.ddm4j.api.document.annotation中的注释类型
描述接口请求参数,及校验,建议所有参数使用 bean 包装,建议使用 JSON 交互(请求参数前加 @RequestBody),不支持 Map
ApiResponseHides - com.github.ddm4j.api.document.annotation中的注释类型
需要隐藏的参数
ApiResponseParam - com.github.ddm4j.api.document.annotation中的注释类型
只能用在 @ApiResponses 注解中,用于描述 返回值 字段
ApiResponses - com.github.ddm4j.api.document.annotation中的注释类型
返回值描述

C

checkByJson(Object, ApiParam[]) - 类 中的静态方法com.github.ddm4j.api.document.check.ApiParamCheck
开始 json 校验
checkClazzType(Class<?>, Type) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
检查 class 类型,用于显示的类型
checkFieldRepeat(List<T>, String) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
检查是否重复
checkFieldType(Type) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
判断类型,不考虑二维数组
checkIsArray(Class<?>) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
判断是不是数组或集合类型
checkParam(JoinPoint, ApiParams) - 类 中的方法com.github.ddm4j.api.document.check.ApiParamCheck
全局校验
checkParamType(Object) - 类 中的静态方法com.github.ddm4j.api.document.check.ApiParamCheck
检查类型
checkType(Type, Type, Boolean) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
检查类型
checkTypeIsBaseOrString(Class<?>) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
判断对象是不是基本数据类型或String
ClassUtil - com.github.ddm4j.api.document.utils中的类
扫描包下面的类
ClassUtil() - 类 的构造器com.github.ddm4j.api.document.utils.ClassUtil
 
com.github.ddm4j.api.document.annotation - 程序包 com.github.ddm4j.api.document.annotation
 
com.github.ddm4j.api.document.bean - 程序包 com.github.ddm4j.api.document.bean
 
com.github.ddm4j.api.document.check - 程序包 com.github.ddm4j.api.document.check
 
com.github.ddm4j.api.document.common.exception - 程序包 com.github.ddm4j.api.document.common.exception
 
com.github.ddm4j.api.document.common.model - 程序包 com.github.ddm4j.api.document.common.model
 
com.github.ddm4j.api.document.config - 程序包 com.github.ddm4j.api.document.config
 
com.github.ddm4j.api.document.controller - 程序包 com.github.ddm4j.api.document.controller
 
com.github.ddm4j.api.document.utils - 程序包 com.github.ddm4j.api.document.utils
 
ControllerVo - com.github.ddm4j.api.document.bean中的类
 
ControllerVo() - 类 的构造器com.github.ddm4j.api.document.bean.ControllerVo
 

D

document(String, String) - 类 中的方法com.github.ddm4j.api.document.controller.ApiDocumentController
获取数据

E

extractClassByType(Type, FieldType) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
提取类型
extractField(Field, T, Type, int) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
 
extractFieldByList(List<T>, String) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
从集合中提取
extractGenType(Type, ParameterizedType, Type) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
查询指定泛型
extractMothodParamerField(Method, Integer, ApiParam[]) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
 
extractMothodReturnField(Method, ApiResponseParam[]) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
提取方法上的返回值

F

FieldType - com.github.ddm4j.api.document.common.model中的枚举
 
FieldTypeInfo - com.github.ddm4j.api.document.common.model中的类
 
FieldTypeInfo() - 类 的构造器com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
findAndAddClassesInPackageByFile(String, String, boolean, Set<Class<?>>) - 类 中的静态方法com.github.ddm4j.api.document.utils.ClassUtil
以文件的形式来获取包下的所有Class

G

getAccount() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
getAuthor() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getAuthor() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getChildren() - 类 中的方法com.github.ddm4j.api.document.bean.ParamChildrenVo
 
getClasses(String) - 类 中的静态方法com.github.ddm4j.api.document.utils.ClassUtil
从包package中获取所有的Class
getClaType() - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
getClazz() - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
getCode() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
getController() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getController() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
getControllers() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
getDescribe() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getDescribe() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
getDescribe() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getDescribe() - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 
getDescribe() - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
getDescribe() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
getError() - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
getField() - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 
getField() - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
getFieldType(int) - 枚举 中的静态方法com.github.ddm4j.api.document.common.model.FieldType
 
getGenType() - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
getHeads() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getI() - 枚举 中的方法com.github.ddm4j.api.document.common.model.FieldType
 
getInsideClazz() - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
getInsideType() - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
getInterfaces() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getJson() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getKey() - 类 中的方法com.github.ddm4j.api.document.common.model.KVEntity
 
getMax() - 类 中的方法com.github.ddm4j.api.document.bean.ParameterVo
 
getMessage() - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
getMethod() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getMethod() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getMin() - 类 中的方法com.github.ddm4j.api.document.bean.ParameterVo
 
getName() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getName() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
getName() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getName() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
getParameters() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getPassword() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
getPath() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
getReg() - 类 中的方法com.github.ddm4j.api.document.bean.ParameterVo
 
getResponseMethod() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getResponses() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getType() - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 
getUri() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getUris() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getUris() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getValue() - 枚举 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckError
 
getValue() - 类 中的方法com.github.ddm4j.api.document.common.model.KVEntity
 
getVersion() - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
getVersion() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
getVersion() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
getVersion() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 

H

HeadVo - com.github.ddm4j.api.document.bean中的类
 
HeadVo() - 类 的构造器com.github.ddm4j.api.document.bean.HeadVo
 

I

InterfaceJsonDoc - com.github.ddm4j.api.document.bean中的类
 
InterfaceJsonDoc() - 类 的构造器com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
InterfaceVo - com.github.ddm4j.api.document.bean中的类
 
InterfaceVo() - 类 的构造器com.github.ddm4j.api.document.bean.InterfaceVo
 
isCheck() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
isDuplicate(List<T>, ParamBaseVo) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
判断是否重复
isEmpty(String) - 类 中的静态方法com.github.ddm4j.api.document.check.ApiParamCheck
判断字符串是否为空
isEmpty(String) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
判断是否为空
isEnable() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
isGeneric(FieldType) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
判断是不是泛型
isJson() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
isLogin() - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
isParamArray() - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
isRequired() - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 

K

KVEntity<K,V> - com.github.ddm4j.api.document.common.model中的类
 
KVEntity() - 类 的构造器com.github.ddm4j.api.document.common.model.KVEntity
 

M

MethodFieldUtil - com.github.ddm4j.api.document.utils中的类
 
MethodFieldUtil() - 类 的构造器com.github.ddm4j.api.document.utils.MethodFieldUtil
 

P

ParamBaseVo - com.github.ddm4j.api.document.bean中的类
 
ParamBaseVo() - 类 的构造器com.github.ddm4j.api.document.bean.ParamBaseVo
 
ParamCheckError - com.github.ddm4j.api.document.common.exception中的枚举
参数校验失败枚举类
ParamCheckException - com.github.ddm4j.api.document.common.exception中的异常错误
字段校验异常对象
ParamCheckException() - 异常错误 的构造器com.github.ddm4j.api.document.common.exception.ParamCheckException
 
ParamCheckException(String, ParamCheckError) - 异常错误 的构造器com.github.ddm4j.api.document.common.exception.ParamCheckException
 
ParamCheckException(String, ParamCheckError, String, String) - 异常错误 的构造器com.github.ddm4j.api.document.common.exception.ParamCheckException
 
ParamChildrenVo<T extends ParamBaseVo> - com.github.ddm4j.api.document.bean中的类
 
ParamChildrenVo() - 类 的构造器com.github.ddm4j.api.document.bean.ParamChildrenVo
 
ParameterVo - com.github.ddm4j.api.document.bean中的类
 
ParameterVo() - 类 的构造器com.github.ddm4j.api.document.bean.ParameterVo
 

R

removeField(List<T>, String) - 类 中的静态方法com.github.ddm4j.api.document.utils.ScanControllerUtil
删除指定属性
replaceResponseField(ApiResponseParam, ResponseVo) - 类 中的静态方法com.github.ddm4j.api.document.utils.MethodFieldUtil
 
ResourcesConfig - com.github.ddm4j.api.document.config中的类
 
ResourcesConfig() - 类 的构造器com.github.ddm4j.api.document.config.ResourcesConfig
 
ResponseVo - com.github.ddm4j.api.document.bean中的类
 
ResponseVo() - 类 的构造器com.github.ddm4j.api.document.bean.ResponseVo
 

S

scan(String, String) - 类 中的静态方法com.github.ddm4j.api.document.utils.ScanControllerUtil
搜索,扫描 Controller
ScanControllerUtil - com.github.ddm4j.api.document.utils中的类
 
ScanControllerUtil() - 类 的构造器com.github.ddm4j.api.document.utils.ScanControllerUtil
 
setAccount(String) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setAuthor(String) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setAuthor(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setCheck(boolean) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setChildren(List<T>) - 类 中的方法com.github.ddm4j.api.document.bean.ParamChildrenVo
 
setClaType(FieldType) - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
setClazz(Class<?>) - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
setCode(Integer) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
setController(String) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setController(String) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setControllers(List<ControllerVo>) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
setDescribe(String) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setDescribe(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
setDescribe(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setDescribe(String) - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 
setDescribe(String) - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
setDescribe(String) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setEnable(boolean) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setError(ParamCheckError) - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
setField(String) - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 
setField(String) - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
setGenType(Type) - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
setHeads(List<HeadVo>) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setI(int) - 枚举 中的方法com.github.ddm4j.api.document.common.model.FieldType
 
setInsideClazz(Class<?>) - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
setInsideType(FieldType) - 类 中的方法com.github.ddm4j.api.document.common.model.FieldTypeInfo
 
setInterfaces(List<InterfaceVo>) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setJson(Boolean) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setJson(boolean) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setKey(K) - 类 中的方法com.github.ddm4j.api.document.common.model.KVEntity
 
setLogin(boolean) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setMax(Integer) - 类 中的方法com.github.ddm4j.api.document.bean.ParameterVo
 
setMessage(String) - 异常错误 中的方法com.github.ddm4j.api.document.common.exception.ParamCheckException
 
setMethod(String) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setMethod(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setMin(Integer) - 类 中的方法com.github.ddm4j.api.document.bean.ParameterVo
 
setName(String) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setName(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
setName(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setName(String) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setParamArray(boolean) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setParameters(List<ParameterVo>) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setPassword(String) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setPath(String) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 
setReg(String) - 类 中的方法com.github.ddm4j.api.document.bean.ParameterVo
 
setRequired(boolean) - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 
setResponseMethod(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setResponses(List<ResponseVo>) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setType(String) - 类 中的方法com.github.ddm4j.api.document.bean.ParamBaseVo
 
setUri(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setUris(List<String>) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setUris(List<String>) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setValue(V) - 类 中的方法com.github.ddm4j.api.document.common.model.KVEntity
 
setVersion(String) - 类 中的方法com.github.ddm4j.api.document.bean.ControllerVo
 
setVersion(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceJsonDoc
 
setVersion(String) - 类 中的方法com.github.ddm4j.api.document.bean.InterfaceVo
 
setVersion(String) - 类 中的方法com.github.ddm4j.api.document.config.ApiDocumentConfig
 

V

valueOf(String) - 枚举 中的静态方法com.github.ddm4j.api.document.common.exception.ParamCheckError
返回带有指定名称的该类型的枚举常量。
valueOf(String) - 枚举 中的静态方法com.github.ddm4j.api.document.common.model.FieldType
返回带有指定名称的该类型的枚举常量。
values() - 枚举 中的静态方法com.github.ddm4j.api.document.common.exception.ParamCheckError
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
values() - 枚举 中的静态方法com.github.ddm4j.api.document.common.model.FieldType
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
A C D E F G H I K M P R S V 
跳过导航链接

Copyright © 2020. All rights reserved.