io.swagger.annotations

Annotation Type ApiImplicitParam

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

Represents a single parameter in an API Operation.

While ApiParam is bound to a JAX-RS parameter, method or field, this allows you to manually define a parameter in a fine-tuned manner. This is the only way to define parameters when using Servlets or other non-JAX-RS environments.

This annotation must be used as a value of ApiImplicitParams in order to be parsed.

See Also:

ApiImplicitParams

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	access Allows for filtering a parameter from the API documentation.
String	allowableValues Limits the acceptable values for this parameter.
boolean	allowEmptyValue Adds the ability to set a format as empty
boolean	allowMultiple Specifies whether the parameter can accept multiple values by having multiple occurrences.
String	collectionFormat adds ability to override collectionFormat with `array` types
String	dataType The data type of the parameter.
Class<?>	dataTypeClass The class of the parameter.
String	defaultValue Describes the default value for the parameter.
String	example a single example for non-body type parameters
Example	examples Examples for the parameter.
String	format Adds the ability to provide a custom format
String	name Name of the parameter.
String	paramType The parameter type of the parameter.
boolean	readOnly adds ability to be designated as read only.
boolean	required Specifies if the parameter is required or not.
String	type Adds the ability to override the detected type
String	value A brief description of the parameter.

Element Detail

name

public abstract String name

Name of the parameter.

For proper Swagger functionality, follow these rules when naming your parameters based on paramType():

1. If paramType is "path", the name should be the associated section in the path.
2. For all other cases, the name should be the parameter name as your application expects to accept.

See Also:

paramType()

Default:

""

value

public abstract String value

A brief description of the parameter.

Default:

""

defaultValue

public abstract String defaultValue

Describes the default value for the parameter.

Default:

""

allowableValues

public abstract String allowableValues

Limits the acceptable values for this parameter.

There are three ways to describe the allowable values:

1. To set a list of values, provide a comma-separated list. For example: first, second, third.
2. To set a range of values, start the value with "range", and surrounding by square brackets include the minimum and maximum values, or round brackets for exclusive minimum and maximum values. For example: range[1, 5], range(1, 5), range[1, 5).
3. To set a minimum/maximum value, use the same format for range but use "infinity" or "-infinity" as the second value. For example, range[1, infinity] means the minimum allowable value of this parameter is 1.

Default:

""

required

public abstract boolean required

Specifies if the parameter is required or not.

Path parameters should always be set as required.

Default:

false

access

public abstract String access

Allows for filtering a parameter from the API documentation.

See io.swagger.core.filter.SwaggerSpecFilter for further details.

Default:

""

allowMultiple

public abstract boolean allowMultiple

Specifies whether the parameter can accept multiple values by having multiple occurrences.

Default:

false

dataType

public abstract String dataType

The data type of the parameter.

This can be the class name or a primitive.

Default:

""

dataTypeClass

public abstract Class<?> dataTypeClass

The class of the parameter.

Overrides dataType if provided.

Default:

java.lang.Void.class

paramType

public abstract String paramType

The parameter type of the parameter.

Valid values are path, query, body, header or form.

Default:

""

example

public abstract String example

a single example for non-body type parameters

Returns:

Since:

1.5.4

Default:

""

examples

public abstract Example examples

Examples for the parameter. Applies only to BodyParameters

Returns:

Since:

1.5.4

Default:

@io.swagger.annotations.Example(@io.swagger.annotations.ExampleProperty(mediaType="", value=""))

type

public abstract String type

Adds the ability to override the detected type

Returns:

Since:

1.5.11

Default:

""

format

public abstract String format

Adds the ability to provide a custom format

Returns:

Since:

1.5.11

Default:

""

allowEmptyValue

public abstract boolean allowEmptyValue

Adds the ability to set a format as empty

Returns:

Since:

1.5.11

Default:

false

readOnly

public abstract boolean readOnly

adds ability to be designated as read only.

Since:

1.5.11

Default:

false

collectionFormat

public abstract String collectionFormat

adds ability to override collectionFormat with `array` types

Since:

1.5.11

Default:

""