@PatchMapping: Difference between revisions
Jump to navigation
Jump to search
(Created page with "=Internal= * Spring MVC Concepts =Overview=") |
(→REST) |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
=Internal= | =Internal= | ||
* [[ | * [[Spring MVC Concepts#.40PatchMapping|Spring MVC Concepts]] | ||
* [[Spring_REST_Concepts#Update_a_Resource|Spring REST Concepts]] | |||
=Overview= | =Overview= | ||
The annotation may also contain a sub-path relative to the class-level base path, usually configured with [[@RequestMapping]]. | |||
=REST= | |||
<syntaxhighlight lang='java'> | |||
@RestController | |||
@RequestMapping(path = "/a", produces = "application/json") | |||
public class AController { | |||
@PatchMapping(path = "/{id}", consumes = "application/json") | |||
public ResponseEntity<A> patch(@PathVariable("id") Integer id, @RequestBody A a) { | |||
A current = content.get(id); | |||
if (current == null) { | |||
return new ResponseEntity<>(null, HttpStatus.NOT_FOUND); | |||
} | |||
if (a.getName() != null) { | |||
current.setName(a.getName()); | |||
} | |||
... | |||
return new ResponseEntity<>(current, HttpStatus.OK); | |||
} | |||
} | |||
</syntaxhighlight> | |||
For possible problems related to [[@RequestBody]] and deserialization from JSON, see: {{Internal|Spring_REST_Concepts#Request_Body_and_Jackson_Deserialization|Request Body and Jackson Deserialization}} | |||
==HTTP POST Semantics for REST Applications== | |||
{{Internal|REST_and_Hypermedia#POST|HTTP POST Semantics for REST Applications}} | |||
==Patching Semantics== | |||
The above implementation has limitations: if null values are meant to specify change, how the client should indicate that a filed should be set to null. Also, collections can only be replaced in bulk, there is no way of adding or removing a subsets of items from a collection. <font color=darkgray>TODO, more here.</font> | |||
==HTTP PATCH Semantics for REST Applications== | |||
{{Internal|REST_and_Hypermedia#PATCH|HTTP PATCH Semantics for REST Applications}} | |||
Latest revision as of 16:01, 27 March 2019
Internal
Overview
The annotation may also contain a sub-path relative to the class-level base path, usually configured with @RequestMapping.
REST
@RestController
@RequestMapping(path = "/a", produces = "application/json")
public class AController {
@PatchMapping(path = "/{id}", consumes = "application/json")
public ResponseEntity<A> patch(@PathVariable("id") Integer id, @RequestBody A a) {
A current = content.get(id);
if (current == null) {
return new ResponseEntity<>(null, HttpStatus.NOT_FOUND);
}
if (a.getName() != null) {
current.setName(a.getName());
}
...
return new ResponseEntity<>(current, HttpStatus.OK);
}
}
For possible problems related to @RequestBody and deserialization from JSON, see:
HTTP POST Semantics for REST Applications
Patching Semantics
The above implementation has limitations: if null values are meant to specify change, how the client should indicate that a filed should be set to null. Also, collections can only be replaced in bulk, there is no way of adding or removing a subsets of items from a collection. TODO, more here.