Skip to content

Commit 93d533d

Browse files
committed
Document auto-configuration support for Spring HATEOAS
Closes gh-2426
1 parent dfdb801 commit 93d533d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1150,6 +1150,22 @@ behaviour by setting `com.ibm.ws.webcontainer.invokeFlushAfterService` to `false
11501150

11511151

11521152

1153+
[[boot-features-spring-hateoas]]
1154+
==== Spring HATEOAS
1155+
If you're developing a RESTful API that makes use of hypermedia, Spring Boot provides
1156+
auto-configuration for Spring HATEOAS that works well with most applications. The
1157+
auto-configuration replaces the need to use `@EnableHypermediaSupport` and registers a
1158+
number of beans to ease building hypermedia-based applications including a
1159+
`LinkDiscoverer` and an `ObjectMapper` configured to correctly marshal responses into
1160+
the desired representation. The `ObjectMapper` will be customized based on the
1161+
`spring.jackson.*` properties or a `Jackson2ObjectMapperBuilder` bean if one exists.
1162+
1163+
You can take control of Spring HATEOAS's configuration by using
1164+
`@EnableHypermediaSupport`. Note that this will disable the `ObjectMapper` customization
1165+
described above.
1166+
1167+
1168+
11531169
[[boot-features-jersey]]
11541170
=== JAX-RS and Jersey
11551171
If you prefer the JAX-RS programming model for REST endpoints you can use one of the

0 commit comments

Comments
 (0)