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	ignore(Method method, ApiExtra extra) 读取接口是否忽略
abstract List<Method>	readAllInterfaces(Class controller, ApiExtra extra)
abstract org.springframework.web.bind.annotation.RequestMethod	requestMethod(Method method, ApiExtra extra) 读取接口请求方式
abstract String	requestUrl(Method method, ApiExtra extra) 读取接口请求路径
abstract String	showName(Method method, ApiExtra extra) 读取接口名称
abstract String	unique(Method method, ApiExtra extra) 接口唯一标识

从类继承的方法 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：非忽略

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 -

返回: