Spring/spring-hateoas-examples
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polishing

Browse Source
This commit is contained in:
Greg Turnquist
2017-12-05 17:20:27 -06:00
parent cca3e88643
commit 04e0dcf4d0
1 changed files with 3 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
affordances/README.adoc
View File

@@ -112,10 +112,8 @@ class EmployeeResourceAssembler extends SimpleIdentifiableResourceAssembler<Empl
protected void addLinks(Resource<Employee> resource) {
resource.getContent().getId()
.ifPresent(id -> {
resource.add(getCollectionLinkBuilder().slash(resource.getContent()).withSelfRel()
.andAffordance(afford(methodOn(EmployeeController.class).updateEmployee(null, id))));
});
.ifPresent(id -> resource.add(getCollectionLinkBuilder().slash(resource.getContent()).withSelfRel()
.andAffordance(afford(methodOn(EmployeeController.class).updateEmployee(null, id)))));
resource.add(getCollectionLinkBuilder().withRel(this.getRelProvider().getCollectionResourceRelFor(this.getResourceType())));
}
@@ -440,42 +438,8 @@ This augments the same REST controller with a *GET* operation for an individual
to update/edit.
Take your team to read both flows. The key part you must define, is the corresponding `EmployeeResourceAssembler.toResource(Employee)` method.
In the heart of that method, is its `addLinks(Resource<Employee> resource)` method:
[source,java]
----
@Component
class EmployeeResourceAssembler extends SimpleIdentifiableResourceAssembler<Employee> {
...
/**
* Define links to add to every {@link Resource}.
*
* @param resource
*/
@Override
protected void addLinks(Resource<Employee> resource) {
resource.getContent().getId()
.ifPresent(id -> resource.add(getCollectionLinkBuilder().slash(resource.getContent()).withSelfRel()
.andAffordance(afford(methodOn(EmployeeController.class).updateEmployee(null, id)))));
resource.add(getCollectionLinkBuilder().withRel(this.getRelProvider().getCollectionResourceRelFor(this.getResourceType())));
}
...
}
----
In this situation, you are taking an individual `Resource<Employee>`, extracting the contents (i.e. the `Employee` itself), grabbing
its `Optional` *id*, and if present, creating a *self* link to it. Again, because `Employee` implements `Identifiable`, `slash(Employee)`
is able to extract the *id* field to form a proper link. This defines the *GET* endpoint as a Spring HATEOAS `Link`.
Using this *self* link, you then add an affordance to the controller's `updateEmployee` method. Spring HATEOAS's Affordances API
is able to inspect the Spring MVC annotations and extract information to render a HAL-FORMS endpoint.
If you restart the application and ping `/employees/1`, you can see an individual entry:
If you ping `/employees/1`, you can see an individual entry:
[source,javascript]
----