spring-framework / org.springframework.web.bind.annotation / RequestBody

RequestBody

@Target([AnnotationTarget.VALUE_PARAMETER]) class RequestBody

Annotation indicating a method parameter should be bound to the body of the web request. The body of the request is passed through an HttpMessageConverter to resolve the method argument depending on the content type of the request. Optionally, automatic validation can be applied by annotating the argument with @Valid.

Supported for annotated handler methods in Servlet environments.

Author
Arjen Poutsma

Since
3.0

See Also
RequestHeaderResponseBodyorg.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter

Constructors

<init>

 RequestBody(required: Boolean)

Annotation indicating a method parameter should be bound to the body of the web request. The body of the request is passed through an HttpMessageConverter to resolve the method argument depending on the content type of the request. Optionally, automatic validation can be applied by annotating the argument with @Valid.

Supported for annotated handler methods in Servlet environments.

Properties

required

 val required: Boolean

Whether body content is required.

Default is true, leading to an exception thrown in case there is no body content. Switch this to false if you prefer null to be passed when the body content is null.