cn.easyutil.easyapi.filter.model

类 DefaultReadInterfaceApi

java.lang.Object

cn.easyutil.easyapi.filter.ReadInterfaceApiFilter

cn.easyutil.easyapi.filter.model.DefaultReadInterfaceApi

public class DefaultReadInterfaceApi
extends ReadInterfaceApiFilter

读取接口方法相关的api

构造器概要

构造器

构造器和说明
DefaultReadInterfaceApi()

方法概要

限定符和类型	方法和说明
BodyType	bodyType(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() 更新策略
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

构造器详细资料

DefaultReadInterfaceApi

public DefaultReadInterfaceApi()

方法详细资料

readAllInterfaces

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

指定者:

readAllInterfaces 在类中 ReadInterfaceApiFilter

ignore

public boolean ignore(Method method,
                      ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

读取接口是否忽略

指定者:

ignore 在类中 ReadInterfaceApiFilter

返回:

true：忽略 false：非忽略

show

public boolean show(Method method,
                    ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

是否展示接口

指定者:

show 在类中 ReadInterfaceApiFilter

返回:

renewType

public RenewType renewType()

从类复制的说明: ReadInterfaceApiFilter

更新策略

指定者:

renewType 在类中 ReadInterfaceApiFilter

bodyType

public BodyType bodyType(Method method,
                         ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

读取接口请求体类型

指定者:

bodyType 在类中 ReadInterfaceApiFilter

返回:

requestUrl

public String requestUrl(Method method,
                         ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

读取接口请求路径

指定者:

requestUrl 在类中 ReadInterfaceApiFilter

参数:

method - 接口方法

返回:

请求路径

requestMethod

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

从类复制的说明: ReadInterfaceApiFilter

读取接口请求方式

指定者:

requestMethod 在类中 ReadInterfaceApiFilter

参数:

method - 接口方法

返回:

请求路径

showName

public String showName(Method method,
                       ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

读取接口名称

指定者:

showName 在类中 ReadInterfaceApiFilter

参数:

method - 接口方法

返回:

接口名称

description

public String description(Method method,
                          ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

读取接口说明

指定者:

description 在类中 ReadInterfaceApiFilter

参数:

method - 接口方法

返回:

接口说明

unique

public String unique(Method method,
                     ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

接口唯一标识

指定者:

unique 在类中 ReadInterfaceApiFilter

返回:

verifyMockTag

public boolean verifyMockTag(String tag,
                             DBModuleInterfaceEntity entity)

从类复制的说明: ReadInterfaceApiFilter

根据tag确定要mock的接口是哪一个

指定者:

verifyMockTag 在类中 ReadInterfaceApiFilter

参数:

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

entity - 接口实例

返回:

确定是否请求了当前接口

enableReqPackage

public boolean enableReqPackage(Method method,
                                ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

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

指定者:

enableReqPackage 在类中 ReadInterfaceApiFilter

参数:

method - 接口方法

extra - 参考数据

enableResPackage

public boolean enableResPackage(Method method,
                                ApiExtra extra)

从类复制的说明: ReadInterfaceApiFilter

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

指定者:

enableResPackage 在类中 ReadInterfaceApiFilter

参数:

method - 接口方法

extra - 参考数据