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

#1054 - Backport fix for unresolved references.

Browse Source
This commit is contained in:
Greg Turnquist
2019-08-14 13:48:14 -05:00
parent ab16f1fe7b
commit c207caca84
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -4,6 +4,8 @@ Oliver Gierke; Greg Turnquist; Jay Bryant
:revdate: {localdate}
:toc: left
:hide-uri-scheme:
:base-dir: ../../../
This project provides some APIs to ease creating REST representations that follow the https://en.wikipedia.org/wiki/HATEOAS[HATEOAS] principle when working with Spring and especially Spring MVC. The core problem it tries to address is link creation and representation assembly.
@@ -381,18 +383,18 @@ The example listed above is the simplest version of traversal, where the rels ar
There are more options to customize template parameters at each level.
[source,java,indent=0]
[source,java,indent=0, tabsize=2]
----
include::{baseDir}/src/test/java/org/springframework/hateoas/client/TraversonTest.java[tag=hop-with-param]
include::{base-dir}/src/test/java/org/springframework/hateoas/client/TraversonTest.java[tag=hop-with-param]
----
The static `rel(...)` function is a convenient way to define a single `Hop`. Using `.withParameter(key, value)` makes it simple to specify URI Template variables.
NOTE: `.withParameter()` returns a new Hop object that is chainable. You can string together as many `.withParameter` as you like. The result is a single Hop definition.
[source,java,indent=0]
[source,java,indent=0, tabsize=2]
----
include::{baseDir}/src/test/java/org/springframework/hateoas/client/TraversonTest.java[tag=hop-put]
include::{base-dir}/src/test/java/org/springframework/hateoas/client/TraversonTest.java[tag=hop-put]
----
It's also possible to load an entire `Map` of parameters via `.withParameters(Map)`.