org.voovan.http.server.module.annontationRouter.annotation

Annotation Type Router

@Repeatable(value=Routers.class)
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Documented
public @interface Router

路由注解类

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
HttpContentType	contentType Content-Type 配置
boolean	deprecated 接口是否已经被废弃，默认是false。
String	description 接口功能详细说明
boolean	hide 是否隐藏接口。
String[]	method 请求的方法
String	path 请求的 URL
boolean	singleton 定义路由类是否采用单例模式 在类上则标识类会被提前实例化, 在路由方法上,则使用提前实例化的类进行调用 在方法上无效
String	summary 接口功能简述
String[]	tags 标签
String	value

Element Detail

path

public abstract String path

请求的 URL

Returns:

请求路径

Default:

""

value

public abstract String value

Returns:

默认路径

Default:

""

method

public abstract String[] method

请求的方法

Returns:

请求的方法

Default:

""

contentType

public abstract HttpContentType contentType

Content-Type 配置

Returns:

HttpContentType 枚举

Default:

org.voovan.http.HttpContentType.TEXT

singleton

public abstract boolean singleton

定义路由类是否采用单例模式 在类上则标识类会被提前实例化, 在路由方法上,则使用提前实例化的类进行调用 在方法上无效

Returns:

true: 单例模式, false: 非单例模式

Default:

true

tags

public abstract String[] tags

标签

Returns:

标签数组

Default:

{}

summary

public abstract String summary

接口功能简述

Returns:

接口功能简述

Default:

""

description

public abstract String description

接口功能详细说明

Returns:

接口功能详细说明

Default:

""

deprecated

public abstract boolean deprecated

接口是否已经被废弃，默认是false。

Returns:

true: 废弃, false: 可用

Default:

false

hide

public abstract boolean hide

是否隐藏接口。

Returns:

true: 隐藏不可展示, false: 可展示

Default:

false