索引

A B C D E F G H I J M N P R S T U V 
All Classes and Interfaces|所有程序包|序列化表格

A

actives() - annotation interface 中的元素 com.citrsw.annatation.ApiEnable
环境，不配置则默认所有环境
addInterceptors(InterceptorRegistry) - 类中的方法 com.citrsw.configuration.ApiConfiguration
配置拦截器执行顺序
addResourceHandlers(ResourceHandlerRegistry) - 类中的方法 com.citrsw.configuration.ApiConfiguration
 
android(Set<String>) - 类中的方法 com.citrsw.definition.DocModel
生成安卓实体类代码
android(Set<String>) - 类中的方法 com.citrsw.definition.DocProperty
生成安卓实体类代码
api() - 类中的方法 com.citrsw.controller.ApiController
 
ApiAppointParam - com.citrsw.annatation中的Annotation Interface
自定义入参字段 使用场景：不需要类中全部的属性
ApiBasicReturn - com.citrsw.annatation中的Annotation Interface
请求参数注解
ApiClass - com.citrsw.annatation中的Annotation Interface
Controller注解
ApiCode - com.citrsw.annatation中的Annotation Interface
状态码
ApiCodeContainer - com.citrsw.annatation中的Annotation Interface
状态码容器
ApiConfiguration - com.citrsw.configuration中的类
配置类
ApiConfiguration(ApiHandlerInterceptor, ApiParamFilter) - 类的构造器 com.citrsw.configuration.ApiConfiguration
 
ApiConstant - com.citrsw.common中的类
写点注释
ApiConstant() - 类的构造器 com.citrsw.common.ApiConstant
 
ApiContext - com.citrsw.core中的类
上下文(核心)
ApiContext(ControllerHandle) - 类的构造器 com.citrsw.core.ApiContext
 
ApiController - com.citrsw.controller中的类
写点注释
ApiController(ApiContext) - 类的构造器 com.citrsw.controller.ApiController
 
apiEnable - 类中的静态变量 com.citrsw.common.ApiConstant
Api是否可用
ApiEnable - com.citrsw.annatation中的Annotation Interface
激活注解
ApiGlobalClass - com.citrsw.annatation中的Annotation Interface
全局类配置 凡是遇到此类则按一下配置生成Api 未配置在此处的属性将不会显示 使用场景：使用第三方的实体时使用
ApiGlobalClassContainer - com.citrsw.annatation中的Annotation Interface
全局类配置 凡是遇到此类则按一下配置生成Api 未配置在此处的属性将不会显示 使用场景：使用第三方的实体时使用
ApiGlobalCode - com.citrsw.annatation中的Annotation Interface
全局状态码
ApiGlobalCodeContainer - com.citrsw.annatation中的Annotation Interface
全局状态码容器
ApiHandlerInterceptor - com.citrsw.interceptor中的类
Api拦截器
ApiHandlerInterceptor() - 类的构造器 com.citrsw.interceptor.ApiHandlerInterceptor
 
ApiIgnore - com.citrsw.annatation中的Annotation Interface
过滤注解
ApiMapParam - com.citrsw.annatation中的Annotation Interface
自定义参数 使用场景：Map类型的参数
ApiMapProperty - com.citrsw.annatation中的Annotation Interface
Map类型属性注解集合
ApiMapPropertyContainer - com.citrsw.annatation中的Annotation Interface
Map类型属性注解集合容器
ApiMapReturn - com.citrsw.annatation中的Annotation Interface
自定义参数 使用场景：Map类型的参数
ApiMethod - com.citrsw.annatation中的Annotation Interface
方法注解
ApiModel - com.citrsw.annatation中的Annotation Interface
模型注解
ApiParam - com.citrsw.annatation中的Annotation Interface
请求参数注解
ApiParameterRequestWrapper - com.citrsw.filter中的类
参数处理器
ApiParameterRequestWrapper(HttpServletRequest) - 类的构造器 com.citrsw.filter.ApiParameterRequestWrapper
解析request的inputStream(即body)数据，转成字符串
ApiParamException - com.citrsw.exception中的异常错误
Api参数校验异常类
ApiParamException(String, DocProperty) - 异常错误的构造器 com.citrsw.exception.ApiParamException
 
ApiParamFilter - com.citrsw.filter中的类
Json过滤器
ApiParamFilter() - 类的构造器 com.citrsw.filter.ApiParamFilter
 
ApiParamModelProperty - com.citrsw.annatation中的Annotation Interface
重新指定入参Model属性注解
ApiParamModelPropertyContainer - com.citrsw.annatation中的Annotation Interface
ApiReturnModelProperty容器
ApiProperty - com.citrsw.annatation中的Annotation Interface
Model属性注解
ApiReturn - com.citrsw.annatation中的Annotation Interface
返回参数注解
ApiReturnModelProperty - com.citrsw.annatation中的Annotation Interface
重新指定出参Model属性注解
ApiReturnModelPropertyContainer - com.citrsw.annatation中的Annotation Interface
ApiModelProperty容器
ApiUtils - com.citrsw.common中的类
写点注释
ApiUtils() - 类的构造器 com.citrsw.common.ApiUtils
 

B

baseTypeMap - 类中的静态变量 com.citrsw.common.ApiConstant
java基本数据类型

C

com.citrsw.annatation - 程序包 com.citrsw.annatation
 
com.citrsw.common - 程序包 com.citrsw.common
 
com.citrsw.configuration - 程序包 com.citrsw.configuration
 
com.citrsw.controller - 程序包 com.citrsw.controller
 
com.citrsw.core - 程序包 com.citrsw.core
 
com.citrsw.definition - 程序包 com.citrsw.definition
 
com.citrsw.enumeration - 程序包 com.citrsw.enumeration
 
com.citrsw.exception - 程序包 com.citrsw.exception
 
com.citrsw.filter - 程序包 com.citrsw.filter
 
com.citrsw.interceptor - 程序包 com.citrsw.interceptor
 
compareTo(DocClass) - 类中的方法 com.citrsw.definition.DocClass
 
compareTo(DocCode) - 类中的方法 com.citrsw.definition.DocCode
 
compareTo(DocMethod) - 类中的方法 com.citrsw.definition.DocMethod
 
compareTo(DocProperty) - 类中的方法 com.citrsw.definition.DocProperty
 
ControllerHandle - com.citrsw.core中的类
处理Controller类
ControllerHandle(MethodHandle) - 类的构造器 com.citrsw.core.ControllerHandle
 

D

defaultValue() - annotation interface 中的元素 com.citrsw.annatation.ApiMapProperty
默认值
defaultValue() - annotation interface 中的元素 com.citrsw.annatation.ApiParam
默认值
defaultValue() - annotation interface 中的元素 com.citrsw.annatation.ApiParamModelProperty
默认值
defaultValue() - annotation interface 中的元素 com.citrsw.annatation.ApiProperty
默认值
description() - annotation interface 中的元素 com.citrsw.annatation.ApiBasicReturn
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiCode
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalClass
类描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalCode
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiMapProperty
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiParam
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiParamModelProperty
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiProperty
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiReturn
描述
description() - annotation interface 中的元素 com.citrsw.annatation.ApiReturnModelProperty
描述
Doc - com.citrsw.definition中的类
Api结果集
Doc() - 类的构造器 com.citrsw.definition.Doc
 
DOC_GLOBAL_CODES - 类中的静态变量 com.citrsw.common.ApiConstant
全局状态码
DocClass - com.citrsw.definition中的类
类信息
DocClass() - 类的构造器 com.citrsw.definition.DocClass
 
DocCode - com.citrsw.definition中的类
状态码定义
DocCode() - 类的构造器 com.citrsw.definition.DocCode
 
DocMethod - com.citrsw.definition中的类
方法信息
DocMethod() - 类的构造器 com.citrsw.definition.DocMethod
 
DocModel - com.citrsw.definition中的类
模型信息
DocModel() - 类的构造器 com.citrsw.definition.DocModel
 
DocProperty - com.citrsw.definition中的类
属性信息
DocProperty() - 类的构造器 com.citrsw.definition.DocProperty
 
doFilter(ServletRequest, ServletResponse, FilterChain) - 类中的方法 com.citrsw.filter.ApiParamFilter
 
down() - 类中的方法 com.citrsw.controller.ApiController
 

E

equals(Object) - 类中的方法 com.citrsw.common.ParameterizedTypeImpl
 
equals(Object) - 类中的方法 com.citrsw.definition.DocCode
 
example() - annotation interface 中的元素 com.citrsw.annatation.ApiMapProperty
示例
example() - annotation interface 中的元素 com.citrsw.annatation.ApiParam
示例
example() - annotation interface 中的元素 com.citrsw.annatation.ApiParamModelProperty
示例
example() - annotation interface 中的元素 com.citrsw.annatation.ApiProperty
示例
example() - annotation interface 中的元素 com.citrsw.annatation.ApiReturnModelProperty
示例

F

format() - annotation interface 中的元素 com.citrsw.annatation.ApiBasicReturn
数据格式(一般用于日期)[yyyy-MM-dd HH:mm:ss]
format() - annotation interface 中的元素 com.citrsw.annatation.ApiMapProperty
数据格式(一般用于日期)[yyyy-MM-dd HH:mm:ss]
format() - annotation interface 中的元素 com.citrsw.annatation.ApiParam
数据格式(一般用于日期)[yyyy-MM-dd HH:mm:ss]
format() - annotation interface 中的元素 com.citrsw.annatation.ApiReturn
数据格式(一般用于日期)[yyyy-MM-dd HH:mm:ss]

G

generate(Doc) - 类中的方法 com.citrsw.core.MarkdownHandler
 
getActualTypeArguments() - 类中的方法 com.citrsw.common.ParameterizedTypeImpl
Returns an array of Type objects representing the actual type arguments to this type.
getBody() - 类中的方法 com.citrsw.filter.ApiParameterRequestWrapper
 
getDoc() - 类中的方法 com.citrsw.core.ApiContext
 
getInputStream() - 类中的方法 com.citrsw.filter.ApiParameterRequestWrapper
 
getJson(String, StringBuilder, boolean, boolean, Map<String, DocProperty>) - 类中的方法 com.citrsw.definition.DocProperty
json形式
getLocalIp() - 类中的静态方法 com.citrsw.common.ApiUtils
获取内网IP
getOwnerType() - 类中的方法 com.citrsw.common.ParameterizedTypeImpl
Returns a Type object representing the type that this type is a member of.
getParamAndroid() - 类中的方法 com.citrsw.definition.TempMethod
生成入参安卓实体类代码
getParamExample() - 类中的方法 com.citrsw.definition.TempMethod
json入参例子(没写错，是方法名起错了)
getParamIos() - 类中的方法 com.citrsw.definition.TempMethod
生成IOS实体类代码
getParamJson() - 类中的方法 com.citrsw.definition.TempMethod
json入参
getParams() - 类中的方法 com.citrsw.definition.TempMethod
form-data入参例子
getParamVue() - 类中的方法 com.citrsw.definition.TempMethod
生成请求Vue代码
getParentField(Class<?>, String) - 类中的方法 com.citrsw.core.ModelHandle
获取父类中的属性
getRawType() - 类中的方法 com.citrsw.common.ParameterizedTypeImpl
Returns the Type object representing the class or interface that declared this type.
getReader() - 类中的方法 com.citrsw.filter.ApiParameterRequestWrapper
 
getReturnAndroid() - 类中的方法 com.citrsw.definition.TempMethod
生成响应安卓实体类代码
getReturnIos() - 类中的方法 com.citrsw.definition.TempMethod
生成IOS实体类代码
getReturnJson() - 类中的方法 com.citrsw.definition.TempMethod
json出参
getReturnVue() - 类中的方法 com.citrsw.definition.TempMethod
生成响应Vue代码

H

handleClass(Set<Class<?>>) - 类中的方法 com.citrsw.core.ControllerHandle
处理扫描到的类
handleGeneric(DocProperty, Type, Map<String, Boolean>, boolean, boolean, Set<Class<?>>, Map<String, ApiParamModelProperty>, Map<String, ApiReturnModelProperty>, Map<String, ApiMapProperty>, Map<String, ApiParam>, Map<String, ApiReturn>, Map<String, ApiProperty>, Map<String, ApiProperty>) - 类中的方法 com.citrsw.core.ModelHandle
处理泛型
handleMap(DocProperty, Type, Map<String, Boolean>, boolean, boolean, Set<Class<?>>, Map<String, ApiParamModelProperty>, Map<String, ApiReturnModelProperty>, Map<String, ApiMapProperty>, Map<String, ApiParam>, Map<String, ApiReturn>, Map<String, ApiProperty>, Map<String, ApiProperty>) - 类中的方法 com.citrsw.core.ModelHandle
处理Map
handleMethod(Method[], RequestMapping) - 类中的方法 com.citrsw.core.MethodHandle
处理Controller中的方法
handleModel(DocProperty, Class<?>, Type, Map<String, Boolean>, boolean, boolean, Set<Class<?>>, Map<String, ApiParamModelProperty>, Map<String, ApiReturnModelProperty>, Map<String, ApiMapProperty>, Map<String, ApiParam>, Map<String, ApiReturn>, Map<String, ApiProperty>, Map<String, ApiProperty>) - 类中的方法 com.citrsw.core.ModelHandle
处理模型
handleParam(ApiMapParam, ApiAppointParam, ApiParamModelProperty[], Parameter[]) - 类中的方法 com.citrsw.core.ParamHandle
处理方法的入参
handleReturn(ApiMapReturn, ApiBasicReturn, Class<?>, Type, ApiReturnModelProperty[]) - 类中的方法 com.citrsw.core.ReturnHandle
处理方法的出参
hashCode() - 类中的方法 com.citrsw.common.ParameterizedTypeImpl
 
hashCode() - 类中的方法 com.citrsw.definition.DocCode
 
humpToLine(String) - 类中的方法 com.citrsw.core.ModelHandle
驼峰转下划线

I

ios(Set<String>) - 类中的方法 com.citrsw.definition.DocModel
生成IOS实体类代码
ios(Set<String>) - 类中的方法 com.citrsw.definition.DocProperty
生成IOS实体类代码

J

javaToIosType(String) - 类中的静态方法 com.citrsw.common.ApiUtils
java类型转Ios类型

M

make(Class<?>, Type[], Type) - 类中的静态方法 com.citrsw.common.ParameterizedTypeImpl
Static factory.
MarkdownHandler - com.citrsw.core中的类
Markdown处理类
MarkdownHandler() - 类的构造器 com.citrsw.core.MarkdownHandler
 
MethodHandle - com.citrsw.core中的类
处理Controller类中的方法
MethodHandle(ParamHandle, ReturnHandle) - 类的构造器 com.citrsw.core.MethodHandle
 
methodMap - 类中的静态变量 com.citrsw.common.ApiConstant
参数校验不通过的返回对象
ModelHandle - com.citrsw.core中的类
处理模型类
ModelHandle() - 类的构造器 com.citrsw.core.ModelHandle
 

N

name() - annotation interface 中的元素 com.citrsw.annatation.ApiCode
名称
name() - annotation interface 中的元素 com.citrsw.annatation.ApiEnable
项目名称
name() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalClass
类名
name() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalCode
名称
name() - annotation interface 中的元素 com.citrsw.annatation.ApiMapProperty
名称 支持多级配置 例如：user.info.level
name() - annotation interface 中的元素 com.citrsw.annatation.ApiParam
名称
name() - annotation interface 中的元素 com.citrsw.annatation.ApiParamModelProperty
名称 支持多级配置 例如：user.info.level
name() - annotation interface 中的元素 com.citrsw.annatation.ApiProperty
名称
name() - annotation interface 中的元素 com.citrsw.annatation.ApiReturn
名称
name() - annotation interface 中的元素 com.citrsw.annatation.ApiReturnModelProperty
名称 支持多级配置 例如：user.info.level
nonRequire() - annotation interface 中的元素 com.citrsw.annatation.ApiAppointParam
非必须属性 表示非必须传值的属性 支持多级配置 例如：user.info.level

P

param(DocProperty, Map<String, DocProperty>) - 类中的方法 com.citrsw.definition.DocProperty
form-data形式
PARAM - enum class 中的枚举常量 com.citrsw.enumeration.TypeEnum
入参
PARAM_GLOBAL_CLASS_DESCRIPTION_MAP - 类中的静态变量 com.citrsw.common.ApiConstant
 
PARAM_GLOBAL_CLASS_MAP - 类中的静态变量 com.citrsw.common.ApiConstant
全局入参类注解
paramAndroid - 类中的变量 com.citrsw.definition.DocMethod
生成入参安卓实体类代码
ParameterizedTypeImpl - com.citrsw.common中的类
拷贝的JDK中的类
paramExample() - 类中的方法 com.citrsw.definition.DocModel
 
ParamHandle - com.citrsw.core中的类
处理方法入参
ParamHandle(ModelHandle) - 类的构造器 com.citrsw.core.ParamHandle
 
paramIos - 类中的变量 com.citrsw.definition.DocMethod
生成入参IOS实体类代码
paramJson(Map<String, DocProperty>) - 类中的方法 com.citrsw.definition.DocModel
 
params(Map<String, DocProperty>) - 类中的方法 com.citrsw.definition.DocModel
 
paramVerification - 类中的静态变量 com.citrsw.common.ApiConstant
参数校验不通过的返回对象
paramVerification() - annotation interface 中的元素 com.citrsw.annatation.ApiEnable
参数校验
paramVue - 类中的变量 com.citrsw.definition.DocMethod
生成请求Vue代码
paramVue(StringBuilder, StringBuilder, String, Map<String, Map<String, String>>) - 类中的方法 com.citrsw.definition.DocProperty
 
paramVue(Map<String, Map<String, String>>) - 类中的方法 com.citrsw.definition.DocModel
生成请求Vue代码
preHandle(HttpServletRequest, HttpServletResponse, Object) - 类中的方法 com.citrsw.interceptor.ApiHandlerInterceptor
 
properties() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalClass
属性集合

R

realType(Type, TypeVariable<? extends Class<?>>[], Type) - 类中的方法 com.citrsw.core.ModelHandle
对包含泛型的属性类型进行重新包装
regenerateType(Type) - 类中的静态方法 com.citrsw.common.ApiUtils
重新生成符合泛型形式的Type 用于返回形式的泛型
require() - annotation interface 中的元素 com.citrsw.annatation.ApiAppointParam
必须属性 表示必须要传值的属性 支持多级配置 例如：user.info.level
required() - annotation interface 中的元素 com.citrsw.annatation.ApiMapProperty
是否必须
required() - annotation interface 中的元素 com.citrsw.annatation.ApiParam
是否必须
required() - annotation interface 中的元素 com.citrsw.annatation.ApiParamModelProperty
是否必须
required() - annotation interface 中的元素 com.citrsw.annatation.ApiProperty
是否必须
RETURN - enum class 中的枚举常量 com.citrsw.enumeration.TypeEnum
出参
RETURN_GLOBAL_CLASS_DESCRIPTION_MAP - 类中的静态变量 com.citrsw.common.ApiConstant
 
RETURN_GLOBAL_CLASS_MAP - 类中的静态变量 com.citrsw.common.ApiConstant
全局出参类注解
returnAndroid - 类中的变量 com.citrsw.definition.DocMethod
生成入参响应安卓实体类代码
ReturnHandle - com.citrsw.core中的类
处理方法返回参数
ReturnHandle(ModelHandle) - 类的构造器 com.citrsw.core.ReturnHandle
 
returnIos - 类中的变量 com.citrsw.definition.DocMethod
生成响应IOS实体类代码
returnJson() - 类中的方法 com.citrsw.definition.DocModel
 
returnVue - 类中的变量 com.citrsw.definition.DocMethod
生成响应Vue代码
returnVue(StringBuilder, String, Map<String, Map<String, String>>) - 类中的方法 com.citrsw.definition.DocProperty
 
returnVue(Map<String, Map<String, String>>) - 类中的方法 com.citrsw.definition.DocModel
生成响应Vue代码
run(String...) - 类中的方法 com.citrsw.core.ApiContext
 

S

scanner(String, Set<Class<?>>) - 类中的方法 com.citrsw.core.ControllerHandle
递归扫描 获取包含RestController注解的类
servletRegistrationBean() - 类中的方法 com.citrsw.configuration.ApiConfiguration
 

T

takePackages(Class<?>) - 类中的方法 com.citrsw.core.ControllerHandle
获取需要扫描的包
TempMethod - com.citrsw.definition中的类
方法信息
TempMethod() - 类的构造器 com.citrsw.definition.TempMethod
 
toString() - 类中的方法 com.citrsw.common.ParameterizedTypeImpl
 
type() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalClass
类型 入参或出参
type() - annotation interface 中的元素 com.citrsw.annatation.ApiMapProperty
数据类型[int,long,date,string,double]
type() - annotation interface 中的元素 com.citrsw.annatation.ApiParam
数据类型[int,long,date,string,double]
type() - annotation interface 中的元素 com.citrsw.annatation.ApiReturn
数据类型[int,long,datetime,date,time,string,double,[]]
TypeEnum - com.citrsw.enumeration中的Enum Class
类型
typeReverseMap - 类中的静态变量 com.citrsw.common.ApiConstant
java基本数据类型

U

underscore - 类中的静态变量 com.citrsw.common.ApiConstant
是否使用下滑线命名方式
underscore() - annotation interface 中的元素 com.citrsw.annatation.ApiEnable
已过时, 待删除: 此 API 元素将从以后的版本中删除。
因为在实际开发中“下划线（蛇形）命名”会给前后端联调带来极大不便，故不建议采用此种形式，此属性也将会在未来版本中移除。

V

value() - annotation interface 中的元素 com.citrsw.annatation.ApiClass
描述
value() - annotation interface 中的元素 com.citrsw.annatation.ApiCode
值
value() - annotation interface 中的元素 com.citrsw.annatation.ApiCodeContainer
 
value() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalClassContainer
 
value() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalCode
值
value() - annotation interface 中的元素 com.citrsw.annatation.ApiGlobalCodeContainer
 
value() - annotation interface 中的元素 com.citrsw.annatation.ApiMapParam
 
value() - annotation interface 中的元素 com.citrsw.annatation.ApiMapPropertyContainer
 
value() - annotation interface 中的元素 com.citrsw.annatation.ApiMapReturn
 
value() - annotation interface 中的元素 com.citrsw.annatation.ApiMethod
描述
value() - annotation interface 中的元素 com.citrsw.annatation.ApiModel
描述
value() - annotation interface 中的元素 com.citrsw.annatation.ApiParamModelPropertyContainer
 
value() - annotation interface 中的元素 com.citrsw.annatation.ApiReturnModelPropertyContainer
 
valueOf(String) - enum class中的静态方法 com.citrsw.enumeration.TypeEnum
Returns the enum constant of this class with the specified name.
values() - enum class中的静态方法 com.citrsw.enumeration.TypeEnum
Returns an array containing the constants of this enum class, in the order they are declared.
A B C D E F G H I J M N P R S T U V 
All Classes and Interfaces|所有程序包|序列化表格