io.swagger.annotations.DynamicParameter Maven / Gradle / Ivy
/*
* Copyright (C) 2018 Zhejiang xiaominfo Technology CO.,LTD.
* All rights reserved.
* Official Web Site: http://www.xiaominfo.com.
* Developer Web Site: http://open.xiaominfo.com.
*/
package io.swagger.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface DynamicParameter {
/**
* Name of the parameter.
* @return 属性名称
*/
String name() default "";
/**
* A brief description of the parameter.
* @return 属性说明
*/
String value() default "";
/**
* Specifies if the parameter is required or not.
*
* Path parameters should always be set as required.
* @return 是否必传
*/
boolean required() default false;
/**
* The class of the parameter.
*
* Overrides {@code dataType} if provided.
* @return 属性类型
*/
Class dataTypeClass() default Void.class;
/**
* a single example for non-body type parameters
*
* @since 1.5.4
*
* @return 属性示例
*/
String example() default "";
}