cn.easyutil.easyapi.filter

类 ReadRequestParamApiFilter

java.lang.Object

cn.easyutil.easyapi.filter.ReadRequestParamApiFilter

直接已知子类:

DefaultReadRequestParamApi

public abstract class ReadRequestParamApiFilter
extends Object

读取请求参数相关的api

构造器概要

构造器

构造器和说明
ReadRequestParamApiFilter()

方法概要

限定符和类型	方法和说明
abstract List<String>	conditons(Parameter parameter, ApiExtra extra) 参数校验,返回el表达式
abstract String	description(Parameter parameter, String parameterName, ApiExtra extra) 参数说明
abstract boolean	ignore(Parameter parameter, Type parameterType, Class parameterClass, ApiExtra extra) 是否忽略该参数
abstract String	mockTemplate(Parameter parameter, ApiExtra extra)
abstract String	parameterName(Parameter parameter, ApiExtra extra) 读取参数名称
abstract Type	parameterType(Parameter parameter, ApiExtra extra) 获取参数类型
abstract boolean	required(Parameter parameter, ApiExtra extra)
abstract boolean	show(Parameter parameter, ApiExtra extra)

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

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

构造器详细资料

ReadRequestParamApiFilter

public ReadRequestParamApiFilter()

方法详细资料

ignore

public abstract boolean ignore(Parameter parameter,
                               Type parameterType,
                               Class parameterClass,
                               ApiExtra extra)

是否忽略该参数

参数:

parameter -

parameterType -

parameterClass -

返回:

parameterName

public abstract String parameterName(Parameter parameter,
                                     ApiExtra extra)

读取参数名称

参数:

parameter -

返回:

parameterType

public abstract Type parameterType(Parameter parameter,
                                   ApiExtra extra)

获取参数类型

参数:

parameter -

返回:

description

public abstract String description(Parameter parameter,
                                   String parameterName,
                                   ApiExtra extra)

参数说明

参数:

parameter -

返回:

mockTemplate

public abstract String mockTemplate(Parameter parameter,
                                    ApiExtra extra)

required

public abstract boolean required(Parameter parameter,
                                 ApiExtra extra)

show

public abstract boolean show(Parameter parameter,
                             ApiExtra extra)

conditons

public abstract List<String> conditons(Parameter parameter,
                                       ApiExtra extra)

参数校验,返回el表达式

返回: