类的使用
cn.easyutil.easyapi.filter.ApiExtra

使用ApiExtra的程序包

程序包	说明
cn.easyutil.easyapi.filter
cn.easyutil.easyapi.filter.model
cn.easyutil.easyapi.logic.creator

cn.easyutil.easyapi.filter中ApiExtra的使用

参数类型为ApiExtra的cn.easyutil.easyapi.filter中的方法

限定符和类型	方法和说明
abstract String	ReadControllerApiFilter.author(Class controller, ApiExtra extra) 控制器作者
abstract BodyType	ReadInterfaceApiFilter.bodyType(Method method, ApiExtra extra) 读取接口请求体类型
abstract List<String>	ReadJavaBeanApiFilter.conditons(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 参数校验,返回el表达式
abstract List<String>	ReadRequestParamApiFilter.conditons(Parameter parameter, ApiExtra extra) 参数校验,返回el表达式
abstract String	ReadControllerApiFilter.description(Class controller, ApiExtra extra) 控制器描述
abstract String	ReadJavaBeanApiFilter.description(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean字段说明
abstract String	ReadResponseParamApiFilter.description(Method method, ApiExtra extra) 参数说明
abstract String	ReadInterfaceApiFilter.description(Method method, ApiExtra extra) 读取接口说明
abstract String	ReadRequestParamApiFilter.description(Parameter parameter, String parameterName, ApiExtra extra) 参数说明
abstract boolean	ReadInterfaceApiFilter.enableReqPackage(Method method, ApiExtra extra) 是否开启请求参数外包装(如果存在包装的话)
abstract boolean	ReadInterfaceApiFilter.enableResPackage(Method method, ApiExtra extra) 是否开启响应参数外包装(如果存在包装的话)
abstract boolean	ReadControllerApiFilter.ignore(Class controller, ApiExtra extra) 读取controller是否忽略
abstract boolean	ReadJavaBeanApiFilter.ignore(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean属性是否忽略
abstract boolean	ReadInterfaceApiFilter.ignore(Method method, ApiExtra extra) 读取接口是否忽略
abstract boolean	ReadRequestParamApiFilter.ignore(Parameter parameter, Type parameterType, Class parameterClass, ApiExtra extra) 是否忽略该参数
abstract boolean	ReadResponseParamApiFilter.ignore(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
abstract JavaType	ReadJavaBeanApiFilter.javaType(Class aClass, GenericTypeBind bind, Type type, ApiExtra extra) 读取实体bean类型
abstract String	ReadJavaBeanApiFilter.mockTemplate(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean的mock数据
abstract String	ReadResponseParamApiFilter.mockTemplate(Method method, ApiExtra extra)
abstract String	ReadRequestParamApiFilter.mockTemplate(Parameter parameter, ApiExtra extra)
abstract String	ReadJavaBeanApiFilter.name(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 字段名称
abstract String	ReadRequestParamApiFilter.parameterName(Parameter parameter, ApiExtra extra) 读取参数名称
abstract Type	ReadRequestParamApiFilter.parameterType(Parameter parameter, ApiExtra extra) 获取参数类型
abstract List<Method>	ReadInterfaceApiFilter.readAllInterfaces(Class controller, ApiExtra extra)
abstract org.springframework.web.bind.annotation.RequestMethod	ReadInterfaceApiFilter.requestMethod(Method method, ApiExtra extra) 读取接口请求方式
abstract String	ReadControllerApiFilter.requestPath(Class controller, ApiExtra extra) 读取controller上的父路径
abstract String	ReadInterfaceApiFilter.requestUrl(Method method, ApiExtra extra) 读取接口请求路径
abstract boolean	ReadJavaBeanApiFilter.required(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean属性是否必须
abstract boolean	ReadRequestParamApiFilter.required(Parameter parameter, ApiExtra extra)
abstract boolean	ReadResponseParamApiFilter.required(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
abstract Type	ReadResponseParamApiFilter.returnType(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra) 解析返回值类型
abstract boolean	ReadControllerApiFilter.show(Class controller, ApiExtra extra) 是否展示controller
abstract boolean	ReadJavaBeanApiFilter.show(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean属性是否显示
abstract boolean	ReadInterfaceApiFilter.show(Method method, ApiExtra extra) 是否展示接口
abstract boolean	ReadRequestParamApiFilter.show(Parameter parameter, ApiExtra extra)
abstract boolean	ReadResponseParamApiFilter.show(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
abstract String	ReadControllerApiFilter.showName(Class controller, ApiExtra extra) 读取controller名称
abstract String	ReadInterfaceApiFilter.showName(Method method, ApiExtra extra) 读取接口名称
abstract Type	ReadJavaBeanApiFilter.type(Class aClass, GenericTypeBind bind, Type type, ApiExtra extra) 将实体bean的类型转换为其他类型进行解析
abstract String	ReadInterfaceApiFilter.unique(Method method, ApiExtra extra) 接口唯一标识

cn.easyutil.easyapi.filter.model中ApiExtra的使用

参数类型为ApiExtra的cn.easyutil.easyapi.filter.model中的方法

限定符和类型	方法和说明
String	DefaultReadControllerApi.author(Class controller, ApiExtra extra)
BodyType	DefaultReadInterfaceApi.bodyType(Method method, ApiExtra extra)
List<String>	DefaultReadJavaBeanApi.conditons(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra)
List<String>	DefaultReadRequestParamApi.conditons(Parameter parameter, ApiExtra extra)
String	DefaultReadControllerApi.description(Class controller, ApiExtra extra)
String	DefaultReadJavaBeanApi.description(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra)
String	DefaultReadResponseParamApi.description(Method method, ApiExtra extra)
String	DefaultReadInterfaceApi.description(Method method, ApiExtra extra)
String	DefaultReadRequestParamApi.description(Parameter parameter, String parameterName, ApiExtra extra)
boolean	DefaultReadInterfaceApi.enableReqPackage(Method method, ApiExtra extra)
boolean	DefaultReadInterfaceApi.enableResPackage(Method method, ApiExtra extra)
boolean	DefaultReadControllerApi.ignore(Class controller, ApiExtra extra)
boolean	DefaultReadJavaBeanApi.ignore(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra)
boolean	DefaultReadInterfaceApi.ignore(Method method, ApiExtra extra)
boolean	DefaultReadRequestParamApi.ignore(Parameter parameter, Type parameterType, Class parameterClass, ApiExtra extra)
boolean	DefaultReadResponseParamApi.ignore(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
JavaType	DefaultReadJavaBeanApi.javaType(Class aClass, GenericTypeBind bind, Type type, ApiExtra extra)
String	DefaultReadJavaBeanApi.mockTemplate(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra)
String	DefaultReadResponseParamApi.mockTemplate(Method method, ApiExtra extra)
String	DefaultReadRequestParamApi.mockTemplate(Parameter parameter, ApiExtra extra)
String	DefaultReadJavaBeanApi.name(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra)
String	DefaultReadRequestParamApi.parameterName(Parameter parameter, ApiExtra extra)
Type	DefaultReadRequestParamApi.parameterType(Parameter parameter, ApiExtra extra)
List<Method>	DefaultReadInterfaceApi.readAllInterfaces(Class controller, ApiExtra extra)
org.springframework.web.bind.annotation.RequestMethod	DefaultReadInterfaceApi.requestMethod(Method method, ApiExtra extra)
String	DefaultReadControllerApi.requestPath(Class controller, ApiExtra extra)
String	DefaultReadInterfaceApi.requestUrl(Method method, ApiExtra extra)
boolean	DefaultReadJavaBeanApi.required(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra)
boolean	DefaultReadRequestParamApi.required(Parameter parameter, ApiExtra extra)
boolean	DefaultReadResponseParamApi.required(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
Type	DefaultReadResponseParamApi.returnType(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
boolean	DefaultReadControllerApi.show(Class controller, ApiExtra extra)
boolean	DefaultReadJavaBeanApi.show(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra)
boolean	DefaultReadInterfaceApi.show(Method method, ApiExtra extra)
boolean	DefaultReadRequestParamApi.show(Parameter parameter, ApiExtra extra)
boolean	DefaultReadResponseParamApi.show(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
String	DefaultReadControllerApi.showName(Class controller, ApiExtra extra)
String	DefaultReadInterfaceApi.showName(Method method, ApiExtra extra)
Type	DefaultReadJavaBeanApi.type(Class aClass, GenericTypeBind bind, Type type, ApiExtra extra)
String	DefaultReadInterfaceApi.unique(Method method, ApiExtra extra)

cn.easyutil.easyapi.logic.creator中ApiExtra的使用

参数类型为ApiExtra的cn.easyutil.easyapi.logic.creator中的方法

限定符和类型	方法和说明
static JavaBeanCreator	JavaBeanCreator.builder(ReadJavaBeanApiFilter filter, String projectBasePath, ReadMockTemplateFilter mockFilter, ApiExtra extra)
InterfaceCreator	InterfaceCreator.setApiExtra(ApiExtra extra)
ApiCreator	ApiCreator.setApiExtra(ApiExtra extra)
ControllerCreator	ControllerCreator.setExtra(ApiExtra extra)
MethodParamsCreator	MethodParamsCreator.withExtra(ApiExtra extra)

参数类型为ApiExtra的cn.easyutil.easyapi.logic.creator中的构造器

构造器和说明
JavaBeanCreator(ReadJavaBeanApiFilter filter, String projectBasePath, ReadMockTemplateFilter mockFilter, ApiExtra extra)