org.springframework.web.bind.annotation

Annotation Type RequestBody

@Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Documented
public @interface 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.

Since:

3.0

Author:

Arjen Poutsma

See Also:

RequestHeader, ResponseBody, org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter, org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	required Whether body content is required.

Element Detail

required

public abstract boolean required

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.

Since:

3.2

Default:

true