top.hequehua.swagger.annotation

注释类型 ApiParam

@Target(value={TYPE,FIELD})
 @Retention(value=RUNTIME)
public @interface ApiParam

请求/返回参数

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	dataType 数据类型
String	defaultValue 默认值
String	description 参数描述
String	name 参数名称
String	paramType 参数类型
boolean	required 是否必须

元素详细资料

name

public abstract String name

参数名称

返回:

默认值:

""

description

public abstract String description

参数描述

返回:

默认值:

""

required

public abstract boolean required

是否必须

返回:

默认值:

false

dataType

public abstract String dataType

数据类型

返回:

默认值:

"String"

defaultValue

public abstract String defaultValue

默认值

返回:

默认值:

""

paramType

public abstract String paramType

参数类型

默认值:

"query"