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

使用ApiExtra的程序包

程序包	说明
cn.easyutil.easyapi.filter.operator
cn.easyutil.easyapi.filter.readBean
cn.easyutil.easyapi.filter.readBean.model
cn.easyutil.easyapi.filter.readController
cn.easyutil.easyapi.filter.readController.model
cn.easyutil.easyapi.filter.readInterface
cn.easyutil.easyapi.filter.readInterface.model
cn.easyutil.easyapi.filter.readReq
cn.easyutil.easyapi.filter.readReq.model
cn.easyutil.easyapi.filter.readRes
cn.easyutil.easyapi.filter.readRes.model
cn.easyutil.easyapi.logic.creator

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

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

限定符和类型	方法和说明
String	ReadControllerOperator.author(Class controller, ApiExtra extra)
BodyType	ReadInterfaceOperator.bodyType(Method method, ApiExtra extra)
List<String>	ReadRequestOperator.conditions(Type parameterType, ApiExtra extra)
List<String>	ReadBeanOperator.conditions(Type type, GenericTypeBind bind, ApiExtra extra)
List<String>	ReadInterfaceOperator.customSearch(Method method, ApiExtra extra)
String	ReadControllerOperator.description(Class controller, ApiExtra extra)
String	ReadInterfaceOperator.description(Method method, ApiExtra extra)
String	ReadResponseOperator.description(Type type, ApiExtra extra)
String	ReadBeanOperator.description(Type type, GenericTypeBind bind, ApiExtra extra)
String	ReadRequestOperator.description(Type parameterType, String parameterName, ApiExtra extra)
Boolean	ReadInterfaceOperator.enableReqPackage(Method method, ApiExtra extra)
Boolean	ReadInterfaceOperator.enableResPackage(Method method, ApiExtra extra)
Boolean	ReadControllerOperator.ignore(Class controller, ApiExtra extra)
Boolean	ReadInterfaceOperator.ignore(Method method, ApiExtra extra)
Boolean	ReadRequestOperator.ignore(Type parameterType, Class parameterClass, ApiExtra extra)
Boolean	ReadResponseOperator.ignore(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
Boolean	ReadBeanOperator.ignore(Type type, GenericTypeBind bind, ApiExtra extra)
JavaType	ReadBeanOperator.javaType(Type type, GenericTypeBind bind, ApiExtra extra)
String	ReadResponseOperator.mockTemplate(Type type, ApiExtra extra)
String	ReadRequestOperator.mockTemplate(Type parameterType, ApiExtra extra)
String	ReadBeanOperator.mockTemplate(Type type, GenericTypeBind bind, ApiExtra extra)
String	ReadBeanOperator.name(Field field, GenericTypeBind bind, ApiExtra extra)
String	ReadRequestOperator.parameterName(Type parameterType, String parameterName, ApiExtra extra)
Type	ReadRequestOperator.parameterType(Type parameterType, String parameterName, ApiExtra extra)
List<FieldParam>	ReadBeanOperator.params(Class modelClass, GenericTypeBind bind, ApiExtra extra)
void	ReadRequestOperator.params(List<MethodParam> params, ApiExtra extra)
List<Method>	ReadInterfaceOperator.readAllInterfaces(Class controller, ApiExtra extra)
RenewType	ReadInterfaceOperator.renewType(Method method, ApiExtra extra)
RenewType	ReadBeanOperator.renewType(Type type, GenericTypeBind bind, ApiExtra extra)
org.springframework.web.bind.annotation.RequestMethod	ReadInterfaceOperator.requestMethod(Method method, ApiExtra extra)
String	ReadControllerOperator.requestPath(Class controller, ApiExtra extra)
String	ReadInterfaceOperator.requestUrl(Method method, ApiExtra extra)
Boolean	ReadRequestOperator.required(Type parameterType, ApiExtra extra)
Boolean	ReadResponseOperator.required(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
Boolean	ReadBeanOperator.required(Type type, GenericTypeBind bind, ApiExtra extra)
List<MethodParam>	ReadResponseOperator.returnTypes(Method method, ApiExtra extra)
Boolean	ReadControllerOperator.show(Class controller, ApiExtra extra)
Boolean	ReadInterfaceOperator.show(Method method, ApiExtra extra)
Boolean	ReadRequestOperator.show(Type parameterType, ApiExtra extra)
Boolean	ReadResponseOperator.show(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
Boolean	ReadBeanOperator.show(Type type, GenericTypeBind bind, ApiExtra extra)
String	ReadControllerOperator.showName(Class controller, ApiExtra extra)
String	ReadInterfaceOperator.showName(Method method, ApiExtra extra)
Type	ReadBeanOperator.type(Field field, GenericTypeBind bind, ApiExtra extra)
String	ReadInterfaceOperator.unique(Method method, ApiExtra extra)

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

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

限定符和类型	方法和说明
List<String>	ReadBeanCondition.conditions(Type type, GenericTypeBind bind, ApiExtra extra) 参数校验,返回el表达式
String	ReadBeanDescription.description(Type type, GenericTypeBind bind, ApiExtra extra) 读取实体bean字段说明
Boolean	ReadBeanIgnore.ignore(Type type, GenericTypeBind bind, ApiExtra extra) 读取实体bean属性是否忽略
JavaType	ReadBeanJavaType.javaType(Type type, GenericTypeBind bind, ApiExtra extra) 读取实体bean类型
String	ReadBeanMockTemplate.mockTemplate(Type type, GenericTypeBind bind, ApiExtra extra) 读取实体bean的mock数据
String	ReadBeanName.name(Field field, GenericTypeBind bind, ApiExtra extra) 字段名称
List<FieldParam>	ReadBeanParams.params(Class modelClass, GenericTypeBind bind, ApiExtra extra)
RenewType	ReadBeanRenewType.renewType(Type type, GenericTypeBind bind, ApiExtra extra) 更新策略
Boolean	ReadBeanRequired.required(Type type, GenericTypeBind bind, ApiExtra extra) 读取实体bean属性是否必须
Boolean	ReadBeanShow.show(Type type, GenericTypeBind bind, ApiExtra extra) 读取实体bean属性是否显示
Type	ReadBeanType.type(Field field, GenericTypeBind bind, ApiExtra extra) 将实体bean的类型转换为其他类型进行解析

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

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

限定符和类型	方法和说明
List<String>	BeanConditionCommentReader.conditions(Type type, GenericTypeBind bind, ApiExtra extra)
String	BeanDescriptionSwaggerReader.description(Type type, GenericTypeBind bind, ApiExtra extra)
String	BeanDescriptionCommentReader.description(Type type, GenericTypeBind bind, ApiExtra extra)
String	BeanDescriptionApiReader.description(Type type, GenericTypeBind bind, ApiExtra extra)
Boolean	BeanIgnoreCommentReader.ignore(Type type, GenericTypeBind bind, ApiExtra extra)
Boolean	BeanIgnoreApiReader.ignore(Type type, GenericTypeBind bind, ApiExtra extra)
JavaType	BeanJavaTypeCommentReader.javaType(Type type, GenericTypeBind bind, ApiExtra extra)
String	BeanMockTemplateCommentReader.mockTemplate(Type type, GenericTypeBind bind, ApiExtra extra)
List<FieldParam>	BeanParamsCommentReader.params(Class modelClass, GenericTypeBind bind, ApiExtra extra)
Boolean	BeanRequiredSwaggerReader.required(Type type, GenericTypeBind bind, ApiExtra extra)
Boolean	BeanRequiredApiReader.required(Type type, GenericTypeBind bind, ApiExtra extra)
Boolean	BeanShowSwaggerReader.show(Type type, GenericTypeBind bind, ApiExtra extra)
Boolean	BeanShowApiReader.show(Type type, GenericTypeBind bind, ApiExtra extra)
Type	BeanTypeCommentReader.type(Field field, GenericTypeBind bind, ApiExtra extra)

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

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

限定符和类型	方法和说明
String	ReadControllerAuthor.author(Class controller, ApiExtra extra) 控制器作者
String	ReadControllerDescription.description(Class controller, ApiExtra extra) 控制器描述
Boolean	ReadControllerIgnore.ignore(Class controller, ApiExtra extra) 读取controller是否忽略
String	ReadControllerRequestPath.requestPath(Class controller, ApiExtra extra) 读取controller上的父路径
Boolean	ReadControllerShow.show(Class controller, ApiExtra extra) 是否展示controller
String	ReadControllerShowName.showName(Class controller, ApiExtra extra) 读取controller名称

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

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

限定符和类型	方法和说明
String	ControllerAuthorSwaggerReader.author(Class controller, ApiExtra extra)
String	ControllerAuthorCommentReader.author(Class controller, ApiExtra extra)
String	ControllerAuthorApiReader.author(Class controller, ApiExtra extra)
String	ControllerDescSwaggerReader.description(Class controller, ApiExtra extra)
String	ControllerDescCommentReader.description(Class controller, ApiExtra extra)
String	ControllerDescApiReader.description(Class controller, ApiExtra extra)
Boolean	ControllerIgnoreSwaggerReader.ignore(Class controller, ApiExtra extra)
Boolean	ControllerIgnoreCommentReader.ignore(Class controller, ApiExtra extra)
Boolean	ControllerIgnoreApiReader.ignore(Class controller, ApiExtra extra)
String	ControllerRequestPathSwaggerReader.requestPath(Class controller, ApiExtra extra)
String	ControllerRequestPathCommentReader.requestPath(Class controller, ApiExtra extra)
String	ControllerRequestPathApiReader.requestPath(Class controller, ApiExtra extra)
Boolean	ControllerShowSwaggerReader.show(Class controller, ApiExtra extra)
Boolean	ControllerShowCommentReader.show(Class controller, ApiExtra extra)
Boolean	ControllerShowApiReader.show(Class controller, ApiExtra extra)
String	ControllerShowNameSwaggerReader.showName(Class controller, ApiExtra extra)
String	ControllerShowNameCommentReader.showName(Class controller, ApiExtra extra)
String	ControllerShowNameApiReader.showName(Class controller, ApiExtra extra)

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

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

限定符和类型	方法和说明
BodyType	ReadInterfaceBodyType.bodyType(Method method, ApiExtra extra) 读取接口请求体类型
List<String>	ReadInterfaceCustomSearch.customSearch(Method method, ApiExtra extra) 自定义搜索标签
String	ReadInterfaceDescription.description(Method method, ApiExtra extra) 读取接口说明
Boolean	ReadInterfaceEnableReqPackage.enableReqPackage(Method method, ApiExtra extra) 是否开启请求参数外包装(如果存在包装的话)
Boolean	ReadInterfaceEnableResPackage.enableResPackage(Method method, ApiExtra extra) 是否开启响应参数外包装(如果存在包装的话)
Boolean	ReadInterfaceIgnore.ignore(Method method, ApiExtra extra) 读取接口是否忽略
List<Method>	ReadInterfaces.readAllInterfaces(Class controller, ApiExtra extra)
RenewType	ReadInterfaceRenewType.renewType(Method method, ApiExtra extra) 更新策略
org.springframework.web.bind.annotation.RequestMethod	ReadInterfaceRequestMethod.requestMethod(Method method, ApiExtra extra) 读取接口请求方式
String	ReadInterfaceRequestUrl.requestUrl(Method method, ApiExtra extra) 读取接口请求路径
Boolean	ReadInterfaceShow.show(Method method, ApiExtra extra) 是否展示接口
String	ReadInterfaceShowName.showName(Method method, ApiExtra extra) 读取接口名称
String	ReadInterfaceUnique.unique(Method method, ApiExtra extra) 接口唯一标识

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

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

限定符和类型	方法和说明
BodyType	InterfaceBodyTypeCommentReader.bodyType(Method method, ApiExtra extra)
String	InterfaceDescSwaggerReader.description(Method method, ApiExtra extra)
String	InterfaceDescApiReader.description(Method method, ApiExtra extra)
Boolean	InterfaceIgnoreSwaggerReader.ignore(Method method, ApiExtra extra)
Boolean	InterfaceIgnoreApiReader.ignore(Method method, ApiExtra extra)
List<Method>	InterfacesCommentReader.readAllInterfaces(Class controller, ApiExtra extra)
org.springframework.web.bind.annotation.RequestMethod	InterfaceRequestMethodCommentReader.requestMethod(Method method, ApiExtra extra)
String	InterfaceRequestUrlCommentReader.requestUrl(Method method, ApiExtra extra)
Boolean	InterfaceShowApiReader.show(Method method, ApiExtra extra)
String	InterfaceShowNameSwaggerReader.showName(Method method, ApiExtra extra)
String	InterfaceShowNameCommentReader.showName(Method method, ApiExtra extra)
String	InterfaceShowNameApiReader.showName(Method method, ApiExtra extra)
String	InterfaceUniqueCommentReader.unique(Method method, ApiExtra extra)

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

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

限定符和类型	方法和说明
List<String>	ReadRequestCondition.conditions(Type parameterType, ApiExtra extra) 参数校验,返回el表达式
String	ReadRequestDescription.description(Type parameterType, String parameterName, ApiExtra extra) 参数说明
Boolean	ReadRequestIgnore.ignore(Type parameterType, Class parameterClass, ApiExtra extra) 是否忽略该参数
String	ReadRequestMockTemplate.mockTemplate(Type parameterType, ApiExtra extra)
String	ReadRequestName.parameterName(Type parameterType, String parameterName, ApiExtra extra) 读取参数名称
Type	ReadRequestType.parameterType(Type parameterType, String parameterName, ApiExtra extra) 获取参数类型
void	ReadRequestParams.params(List<MethodParam> params, ApiExtra extra) 读取参数列表
Boolean	ReadRequestRequired.required(Type parameterType, ApiExtra extra)
Boolean	ReadRequestShow.show(Type parameterType, ApiExtra extra)

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

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

限定符和类型	方法和说明
List<String>	RequestConditionCommentReader.conditions(Type parameterType, ApiExtra extra)
String	RequestDescriptionSwaggerReader.description(Type parameterType, String parameterName, ApiExtra extra)
String	RequestDescriptionCommentReader.description(Type parameterType, String parameterName, ApiExtra extra)
String	RequestDescriptionApiReader.description(Type parameterType, String parameterName, ApiExtra extra)
Boolean	RequestIgnoreCommentReader.ignore(Type parameterType, Class parameterClass, ApiExtra extra)
String	RequestMockTemplateCommentReader.mockTemplate(Type parameterType, ApiExtra extra)
String	RequestNameCommentReader.parameterName(Type parameterType, String parameterName, ApiExtra extra)
Type	RequestTypeCommentReader.parameterType(Type parameterType, String parameterName, ApiExtra extra)
void	RequestParamsCommentReader.params(List<MethodParam> params, ApiExtra extra)

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

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

限定符和类型	方法和说明
String	ReadResponseDescription.description(Type type, ApiExtra extra) 参数说明
Boolean	ReadResponseIgnore.ignore(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
String	ReadResponseMockTemplate.mockTemplate(Type type, ApiExtra extra)
Boolean	ReadResponseRequired.required(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)
List<MethodParam>	ReadResponseRetrunTypes.returnTypes(Method method, ApiExtra extra) 解析返回值类型
Boolean	ReadResponseShow.show(Type type, Class ownerClass, GenericTypeBind bind, ApiExtra extra)

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

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

限定符和类型	方法和说明
String	ResponseDescriptionCommentReader.description(Type type, ApiExtra extra)
String	ResponseMockTemplateCommentReader.mockTemplate(Type type, ApiExtra extra)
List<MethodParam>	ResponseRetrunTypesCommentReader.returnTypes(Method method, ApiExtra extra)

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

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

限定符和类型	方法和说明
static JavaBeanCreator	JavaBeanCreator.builder(ReadBeanOperator filter, Set<String> projectBasePaths, ReadMockTemplateOperator 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(ReadBeanOperator filter, Set<String> projectBasePaths, ReadMockTemplateOperator mockFilter, ApiExtra extra)