Package org.springframework.web.bind.annotation

Annotation Interface PatchMapping

@Target(METHOD)
@Retention(RUNTIME)
@Documented
@RequestMapping(method=PATCH)
public @interface PatchMapping

Annotation for mapping HTTP PATCH requests onto specific handler methods.

Specifically, @PatchMapping is a composed annotation that acts as a shortcut for @RequestMapping(method = RequestMethod.PATCH).

NOTE: This annotation cannot be used in conjunction with other @RequestMapping annotations that are declared on the same method. If multiple @RequestMapping annotations are detected on the same method, a warning will be logged, and only the first mapping will be used. This applies to @RequestMapping as well as composed @RequestMapping annotations such as @GetMapping, @PostMapping, etc.

Since:

4.3

Author:

Sam Brannen

See Also:

• GetMapping
• PostMapping
• PutMapping
• DeleteMapping
• RequestMapping

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	consumes	Alias for RequestMapping.consumes().
String[]	headers	Alias for RequestMapping.headers().
String	name	Alias for RequestMapping.name().
String[]	params	Alias for RequestMapping.params().
String[]	path	Alias for RequestMapping.path().
String[]	produces	Alias for RequestMapping.produces().
String[]	value	Alias for RequestMapping.value().

Element Details

name

@AliasFor(annotation=RequestMapping.class)
String name

Alias for RequestMapping.name().

Default:

""

value

@AliasFor(annotation=RequestMapping.class)
String[] value

Alias for RequestMapping.value().

Default:

{}

path

@AliasFor(annotation=RequestMapping.class)
String[] path

Alias for RequestMapping.path().

Default:

{}

params

@AliasFor(annotation=RequestMapping.class)
String[] params

Alias for RequestMapping.params().

Default:

{}

headers

@AliasFor(annotation=RequestMapping.class)
String[] headers

Alias for RequestMapping.headers().

Default:

{}

consumes

@AliasFor(annotation=RequestMapping.class)
String[] consumes

Alias for RequestMapping.consumes().

Default:

{}

produces

@AliasFor(annotation=RequestMapping.class)
String[] produces

Alias for RequestMapping.produces().

Default:

{}