com.github.javaclub.sword.annotation.swagger.ApiRequestObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sword Show documentation

Javaclub sword

The newest version!

package com.github.javaclub.sword.annotation.swagger;

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

@Target({ElementType.PARAMETER, ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiRequestObject {

	/**
	 * 不为空时，可作为 MapModel 名称显示
	 */
	String name() default "";

    /**
     * 字段/节点描述，用于文档显示
     */
    String description() default "";

    /**
     * 返回Api对象的字段属性
     */
    ApiRequestProperty[] properties();
    
}