com.zlyx.easyapi.annotations.ApiDesc Maven / Gradle / Ivy

Go to download
package com.zlyx.easyapi.annotations;

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.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;

/**
 * 
 * @auth 赵光
 * @Desc api描述
 * @Date 2018年11月15日 下午2:10:59
 */
@Documented
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Component
public @interface ApiDesc {

	/**
	 * bean名称
	 * 
	 * @return
	 */
	@AliasFor(annotation = Component.class, attribute = "value")
	String value() default "";

	/**
	 * 文档分组名称(没有设置统一划分到default下)
	 * 
	 * @return
	 */
	String name() default "";

	/**
	 * 指定生成文档的注解类型或接口/父类
	 * 
	 * @return
	 */
	Class[] clses() default Void.class;

	/**
	 * 作用
	 * 
	 * @return
	 */
	String[] todo();

}