Spring/spring-data-rest
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATAREST-623 - Added documentation on how to programmatically link to resource controllers.

Browse Source 
Documented how to use RepositoryEntityLinks to link to Spring Data REST controllers.

Original pull request: #195.
This commit is contained in:
Greg Turnquist
2015-08-10 15:09:03 -05:00
committed by Oliver Gierke
parent 867875e610
commit 06e2564f66
2 changed files with 56 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/main/asciidoc/index.adoc
View File

@@ -26,6 +26,7 @@ include::projections-excerpts.adoc[leveloffset=+1]
include::etags-and-other-conditionals.adoc[leveloffset=+1]
include::validation.adoc[leveloffset=+1]
include::events.adoc[leveloffset=+1]
include::integration.adoc[leveloffset=+1]
include::metadata.adoc[leveloffset=+1]
include::security.adoc[leveloffset=+1]
include::tools.adoc[leveloffset=+1]

55
src/main/asciidoc/integration.adoc Normal file
View File

@@ -0,0 +1,55 @@
[[integration]]
= Integration
:spring-data-rest-root: ../../..
This section details various ways to integrate with Spring Data REST components, whether from a Spring application that is using Spring Data REST or from other means.
== Programmatic Links
Sometimes you need to add links to exported resources in your own custom built Spring MVC controllers. There are three basic levels of linking available:
. Manually assembling links
. Using Spring HATEOAS's http://docs.spring.io/spring-hateoas/docs/current/reference/html/#fundamentals.obtaining-links.builder[LinkBuilder] with `linkTo()`, `slash()`, etc.
. Using Spring Data REST's implementation of http://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest/webmvc/support/RepositoryEntityLinks.html[RepositoryEntityLinks].
The first suggestion is terrible and should be avoided at all costs. It makes your code brittle and high risk. The second is handy when creating links to other hand written Spring MVC controllers. The last one, which you'll see in a moment, is good for looking up resource links that are exported by Spring Data REST.
Assuming you have configured your code to use Spring's autowiring,
[source,java]
----
public class MyWebApp {
private RepositoryEntityLinks entityLinks;
@Autowired
public MyWebApp(RepositoryEntityLinks entityLinks) {
this.entityLinks = entityLinks;
}
}
----
...you can then use the following operations:
.Ways to link to exported resources
|===
|Method | Description
|`entityLinks.linkToCollectionResource(Person.class)`
|Provide a link to the collection resource of that type.
|`entityLinks.linkToSingleResource(Person.class, 1)`
|Provide a link to a single resource.
|`entityLinks.linkToPagedResource(Person.class, new PageRequest(...))`
|Provide a link to a paged resource.
|`entityLinks.linksToSearchResources(Person.class)`
|Provides a list of links for all the finder methods exposed by the corresponding repository.
|`entityLinks.linkToSearchResource(Person.class, "findByLastName")`
|Provide a finder link by rel, i.e. the name of the finder.
|===
NOTE: All of the search-based links support extra parameters for paging and sorting. Checkout http://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest/webmvc/support/RepositoryEntityLinks.html[RepositoryEntityLinks] for specifics. There is also `linkFor(Class<?> type)`, but that returns a Spring HATEOAS `LinkBuilder`, which returns you to the lower level API. Try to use the other ones first.