io.swagger.v3.oas.annotations.parameters

Annotation Type RequestBody

@Target(value={METHOD,PARAMETER,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface RequestBody

The annotation may be used on a method parameter to define it as the Request Body of the operation, and/or to define additional properties for such request body.

See Also:

Request Body (OpenAPI specification), Parameter, Content

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Content[]	content The content of the request body.
String	description A brief description of the request body.
Extension[]	extensions The list of optional extensions
String	ref A reference to a RequestBody defined in components RequestBodies.
boolean	required Determines if the request body is required in the request.

Element Detail

description

public abstract String description

A brief description of the request body.

Returns:

description of the request body

Default:

""

content

public abstract Content[] content

The content of the request body.

Returns:

array of content

Default:

{}

required

public abstract boolean required

Determines if the request body is required in the request. Defaults to false.

Returns:

boolean

Default:

false

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}

ref

public abstract String ref

A reference to a RequestBody defined in components RequestBodies.

Returns:

the reference

Since:

2.0.3

Default:

""