diff --git a/src/org/redkale/net/http/RestParam.java b/src/org/redkale/net/http/RestParam.java index 8cbd3437b..8cd41f07c 100644 --- a/src/org/redkale/net/http/RestParam.java +++ b/src/org/redkale/net/http/RestParam.java @@ -10,7 +10,9 @@ import static java.lang.annotation.ElementType.PARAMETER; import static java.lang.annotation.RetentionPolicy.RUNTIME; /** - * 只能依附在Service类的方法的参数上, name值不能是'&' + * + * 依附在RestService类的方法的参数上 ,数据结构与Param类似 + * name='&' 表示当前用户 * name='#'表示截取uri最后一段 * name='#xxx:'表示从uri中/pipes/xxx:v/截取xxx:的值 *
@@ -24,7 +26,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; @Retention(RUNTIME) public @interface RestParam { - String name(); //参数名 name值不能是'&'; name='#'表示截取uri最后一段; name='#xxx:'表示从uri中/pipes/xxx:v/截取xxx:的值 + String name(); //参数名 name='&'表示当前用户; name='#'表示截取uri最后一段; name='#xxx:'表示从uri中/pipes/xxx:v/截取xxx:的值 int radix() default 10; //转换数字byte/short/int/long时所用的进制数, 默认10进制 diff --git a/src/org/redkale/util/Param.java b/src/org/redkale/util/Param.java new file mode 100644 index 000000000..2e6b8180c --- /dev/null +++ b/src/org/redkale/util/Param.java @@ -0,0 +1,38 @@ +/* + * To change this license header, choose License Headers in Project Properties. + * To change this template file, choose Tools | Templates + * and open the template in the editor. + */ +package org.redkale.util; + +import java.lang.annotation.*; +import static java.lang.annotation.ElementType.PARAMETER; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +/** + * + * Param与Comment注解类主要用于Service上加上注释,便于apidoc生成API文档 + * + * 依附在Service类的方法的参数上 ,数据结构与RestParam类似 + * name='&' 表示当前用户 + * name='#'表示截取uri最后一段 + * name='#xxx:'表示从uri中/pipes/xxx:v/截取xxx:的值 + *
+ * 详情见: https://redkale.org + * + * @author zhangjx + */ +@Inherited +@Documented +@Target({PARAMETER}) +@Retention(RUNTIME) +public @interface Param { + + String name(); //参数名 name='&'表示当前用户; name='#'表示截取uri最后一段; name='#xxx:'表示从uri中/pipes/xxx:v/截取xxx:的值 + + int radix() default 10; //转换数字byte/short/int/long时所用的进制数, 默认10进制 + + boolean required() default true; //参数是否必传 + + String comment() default ""; //备注描述 +}