NutzCN Logo
问答 nutz关于注解的一些疑问
发布于 2321天前 作者 qq_19417450 2081 次浏览 复制 上一个帖子 下一个帖子
标签:

@Api(name = " ", description = " ")
@IocBean
@At("")
@Filters({ @By(type = AAA.class) })

像这些注解的作用或者说是什么功能,这些都是在哪里查看,文档里面没有看到
@wendal

9 回复

除了第一个,文档里面都有

@At("")
@Filters({ @By(type = AAA.class) })这两个现在都知道是什么作用,

现在是@Api(name = " ", description = " ")这个不知道是什么意思,能否解释一下哈

apidoc插件的注解?

@Api(name = "XXX", description = "XXX")
@IocBean
@At("")
public class XXXXXController extends BaseController {


类似这样的,是在加载控制层XXXController上面的

@Api的完整package是什么

package org.nutz.plugins.apidoc.annotation;
package org.nutz.plugins.apidoc.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.nutz.plugins.apidoc.ApidocUrlMapping;

/**
 * 供ApidocUrlMapping读取
 * 
 * @author wendal
 * @see ApidocUrlMapping.wendal.nutzbook.mvc.ExpUrlMapping
 */
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Api {
	/**
	 * 给个名字行不行!!
	 * 
	 * @return 模块或入口方法的可读名称
	 */
	String name();

	/**
	 * 长文本描述信息
	 * 
	 * @return 描述一下这个方法大概是干啥的
	 */
	String description() default "";

	/**
	 * 参数列表
	 */
	ApiParam[] params() default {};

	/**
	 * 成功返回
	 * 
	 * @return
	 */
	ReturnKey[] ok() default {};

	/**
	 * 失败返回
	 * 
	 * @return
	 */
	ReturnKey[] fail() default {};

	/**
	 * 作者信息
	 */
	String author() default "";

	/**
	 * 过滤模式,默认为ALL
	 */
	ApiMatchMode match() default ApiMatchMode.ALL;
}

谢谢你哈@wendal

添加回复
请先登陆
回到顶部