com.citrsw.annatation

注释类型 ApiParam

@Target(value={METHOD,PARAMETER})
 @Retention(value=RUNTIME)
 @Documented
public @interface ApiParam

请求参数注解

作者:

Zhenfeng Li

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	defaultValue 默认值
String	description 描述
String	example 示例
String	format 数据格式(一般用于日期)[yyyy-MM-dd HH:mm:ss]
String	name 名称
boolean	required 是否必须
String	type 数据类型[int,long,date,string,double]

元素详细资料

name

public abstract String name

名称

默认值:

""

description

public abstract String description

描述

默认值:

""

required

public abstract boolean required

是否必须

默认值:

false

type

public abstract String type

数据类型[int,long,date,string,double]

默认值:

""

format

public abstract String format

数据格式(一般用于日期)[yyyy-MM-dd HH:mm:ss]

默认值:

""

defaultValue

public abstract String defaultValue

默认值

默认值:

"\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n"

example

public abstract String example

示例

默认值:

""