com.github.xiaoymin.knife4j.annotations

注释类型 DynamicParameter

@Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface DynamicParameter

可选元素概要

可选元素

限定符和类型	可选元素和说明
Class<?>	dataTypeClass The class of the parameter.
String	example a single example for non-body type parameters
String	name Name of the parameter.
boolean	required Specifies if the parameter is required or not.
String	value A brief description of the parameter.

元素详细资料

name

public abstract String name

Name of the parameter.

返回:

属性名称

默认值:

""

value

public abstract String value

A brief description of the parameter.

返回:

属性说明

默认值:

""

required

public abstract boolean required

Specifies if the parameter is required or not.

Path parameters should always be set as required.

返回:

是否必传

默认值:

false

dataTypeClass

public abstract Class<?> dataTypeClass

The class of the parameter.

Overrides dataType if provided.

返回:

属性类型

默认值:

java.lang.Void.class

example

public abstract String example

a single example for non-body type parameters

返回:

属性示例

从以下版本开始:

1.5.4

默认值:

""