org.nutz.plugins.apidoc.annotation.Api Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nutz-plugins-apidoc Show documentation

There is a newer version: 1.r.69.v20220215

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;
}