cn.easyutil.easyapi.filter.operator

类 ReadInterfaceOperator

java.lang.Object

cn.easyutil.easyapi.filter.operator.ReadInterfaceOperator

所有已实现的接口:

ReadInterfaceBodyType, ReadInterfaceCustomSearch, ReadInterfaceDescription, ReadInterfaceEnableReqPackage, ReadInterfaceEnableResPackage, ReadInterfaceIgnore, ReadInterfaceRenewType, ReadInterfaceRequestMethod, ReadInterfaceRequestUrl, ReadInterfaces, ReadInterfaceShow, ReadInterfaceShowName, ReadInterfaceUnique, ReadInterfaceVerifyMockTag

public class ReadInterfaceOperator
extends Object
implements ReadInterfaceBodyType, ReadInterfaceCustomSearch, ReadInterfaceDescription, ReadInterfaceEnableReqPackage, ReadInterfaceEnableResPackage, ReadInterfaceIgnore, ReadInterfaceRenewType, ReadInterfaceRequestUrl, ReadInterfaceRequestMethod, ReadInterfaces, ReadInterfaceShow, ReadInterfaceShowName, ReadInterfaceUnique, ReadInterfaceVerifyMockTag

构造器概要

构造器

构造器和说明
ReadInterfaceOperator(ReadInterfaceConfig config)

方法概要

限定符和类型	方法和说明
BodyType	bodyType(Method method, ApiExtra extra) 读取接口请求体类型
List<String>	customSearch(Method method, ApiExtra extra) 自定义搜索标签
String	description(Method method, ApiExtra extra) 读取接口说明
Boolean	enableReqPackage(Method method, ApiExtra extra) 是否开启请求参数外包装(如果存在包装的话)
Boolean	enableResPackage(Method method, ApiExtra extra) 是否开启响应参数外包装(如果存在包装的话)
Boolean	ignore(Method method, ApiExtra extra) 读取接口是否忽略
List<Method>	readAllInterfaces(Class controller, ApiExtra extra)
RenewType	renewType(Method method, ApiExtra extra) 更新策略
org.springframework.web.bind.annotation.RequestMethod	requestMethod(Method method, ApiExtra extra) 读取接口请求方式
String	requestUrl(Method method, ApiExtra extra) 读取接口请求路径
Boolean	show(Method method, ApiExtra extra) 是否展示接口
String	showName(Method method, ApiExtra extra) 读取接口名称
String	unique(Method method, ApiExtra extra) 接口唯一标识
Boolean	verifyMockTag(String tag, DBModuleInterfaceEntity entity) 根据tag确定是不是需要mock的接口

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ReadInterfaceOperator

public ReadInterfaceOperator(ReadInterfaceConfig config)

方法详细资料

bodyType

public BodyType bodyType(Method method,
                         ApiExtra extra)

从接口复制的说明: ReadInterfaceBodyType

读取接口请求体类型

指定者:

bodyType 在接口中 ReadInterfaceBodyType

返回:

customSearch

public List<String> customSearch(Method method,
                                 ApiExtra extra)

从接口复制的说明: ReadInterfaceCustomSearch

自定义搜索标签

指定者:

customSearch 在接口中 ReadInterfaceCustomSearch

参数:

method - 接口方法

extra - 扩展信息

description

public String description(Method method,
                          ApiExtra extra)

从接口复制的说明: ReadInterfaceDescription

读取接口说明

指定者:

description 在接口中 ReadInterfaceDescription

参数:

method - 接口方法

返回:

接口说明

enableReqPackage

public Boolean enableReqPackage(Method method,
                                ApiExtra extra)

从接口复制的说明: ReadInterfaceEnableReqPackage

是否开启请求参数外包装(如果存在包装的话)

指定者:

enableReqPackage 在接口中 ReadInterfaceEnableReqPackage

参数:

method - 接口方法

extra - 参考数据

enableResPackage

public Boolean enableResPackage(Method method,
                                ApiExtra extra)

从接口复制的说明: ReadInterfaceEnableResPackage

是否开启响应参数外包装(如果存在包装的话)

指定者:

enableResPackage 在接口中 ReadInterfaceEnableResPackage

参数:

method - 接口方法

extra - 参考数据

ignore

public Boolean ignore(Method method,
                      ApiExtra extra)

从接口复制的说明: ReadInterfaceIgnore

读取接口是否忽略

指定者:

ignore 在接口中 ReadInterfaceIgnore

返回:

true：忽略 false：非忽略

renewType

public RenewType renewType(Method method,
                           ApiExtra extra)

从接口复制的说明: ReadInterfaceRenewType

更新策略

指定者:

renewType 在接口中 ReadInterfaceRenewType

requestMethod

public org.springframework.web.bind.annotation.RequestMethod requestMethod(Method method,
                                                                           ApiExtra extra)

从接口复制的说明: ReadInterfaceRequestMethod

读取接口请求方式

指定者:

requestMethod 在接口中 ReadInterfaceRequestMethod

参数:

method - 接口方法

返回:

请求路径

requestUrl

public String requestUrl(Method method,
                         ApiExtra extra)

从接口复制的说明: ReadInterfaceRequestUrl

读取接口请求路径

指定者:

requestUrl 在接口中 ReadInterfaceRequestUrl

参数:

method - 接口方法

返回:

请求路径

show

public Boolean show(Method method,
                    ApiExtra extra)

从接口复制的说明: ReadInterfaceShow

是否展示接口

指定者:

show 在接口中 ReadInterfaceShow

返回:

showName

public String showName(Method method,
                       ApiExtra extra)

从接口复制的说明: ReadInterfaceShowName

读取接口名称

指定者:

showName 在接口中 ReadInterfaceShowName

参数:

method - 接口方法

返回:

接口名称

unique

public String unique(Method method,
                     ApiExtra extra)

从接口复制的说明: ReadInterfaceUnique

接口唯一标识

指定者:

unique 在接口中 ReadInterfaceUnique

返回:

verifyMockTag

public Boolean verifyMockTag(String tag,
                             DBModuleInterfaceEntity entity)

从接口复制的说明: ReadInterfaceVerifyMockTag

根据tag确定是不是需要mock的接口

指定者:

verifyMockTag 在接口中 ReadInterfaceVerifyMockTag

参数:

tag - 请求时传进来的tag标识

entity - 接口实例

返回:

确定是否请求了当前接口

readAllInterfaces

public List<Method> readAllInterfaces(Class controller,
                                      ApiExtra extra)

指定者:

readAllInterfaces 在接口中 ReadInterfaces