cn.easyutil.easyapi.filter

类 ReadInterfaceApiFilter

java.lang.Object

cn.easyutil.easyapi.filter.ReadInterfaceApiFilter

直接已知子类:

DefaultReadInterfaceApi

public abstract class ReadInterfaceApiFilter
extends Object

读取接口方法相关的api

构造器概要

构造器

构造器和说明
ReadInterfaceApiFilter()

方法概要

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

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

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

构造器详细资料

ReadInterfaceApiFilter

public ReadInterfaceApiFilter()

方法详细资料

readAllInterfaces

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

ignore

public abstract boolean ignore(Method method,
                               ApiExtra extra)

读取接口是否忽略

参数:

method -

返回:

true：忽略 false：非忽略

show

public abstract boolean show(Method method,
                             ApiExtra extra)

是否展示接口

参数:

method -

extra -

返回:

renewType

public abstract RenewType renewType()

更新策略

bodyType

public abstract BodyType bodyType(Method method,
                                  ApiExtra extra)

读取接口请求体类型

参数:

method -

返回:

requestUrl

public abstract String requestUrl(Method method,
                                  ApiExtra extra)

读取接口请求路径

参数:

method - 接口方法

返回:

请求路径

requestMethod

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

读取接口请求方式

参数:

method - 接口方法

返回:

请求路径

showName

public abstract String showName(Method method,
                                ApiExtra extra)

读取接口名称

参数:

method - 接口方法

返回:

接口名称

description

public abstract String description(Method method,
                                   ApiExtra extra)

读取接口说明

参数:

method - 接口方法

返回:

接口说明

unique

public abstract String unique(Method method,
                              ApiExtra extra)

接口唯一标识

参数:

method -

返回:

verifyMockTag

public abstract boolean verifyMockTag(String tag,
                                      DBModuleInterfaceEntity entity)

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

参数:

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

entity - 接口实例

返回:

确定是否请求了当前接口

enableReqPackage

public abstract boolean enableReqPackage(Method method,
                                         ApiExtra extra)

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

参数:

method - 接口方法

extra - 参考数据

enableResPackage

public abstract boolean enableResPackage(Method method,
                                         ApiExtra extra)

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

参数:

method - 接口方法

extra - 参考数据