| Package | Description |
|---|---|
| org.springframework.restdocs.hypermedia |
Documenting a RESTful API that uses hypermedia.
|
| Modifier and Type | Method and Description |
|---|---|
static LinkExtractor |
HypermediaDocumentation.atomLinks()
Returns a
LinkExtractor capable of extracting links in Atom format where
the links are found in an array named links. |
static LinkExtractor |
HypermediaDocumentation.halLinks()
Returns a
LinkExtractor capable of extracting links in Hypermedia
Application Language (HAL) format where the links are found in a map named
_links. |
| Modifier and Type | Method and Description |
|---|---|
static LinksSnippet |
HypermediaDocumentation.links(LinkExtractor linkExtractor,
LinkDescriptor... descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.links(LinkExtractor linkExtractor,
java.util.List<LinkDescriptor> descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.links(LinkExtractor linkExtractor,
java.util.Map<java.lang.String,java.lang.Object> attributes,
LinkDescriptor... descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.links(LinkExtractor linkExtractor,
java.util.Map<java.lang.String,java.lang.Object> attributes,
java.util.List<LinkDescriptor> descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor,
LinkDescriptor... descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor,
java.util.List<LinkDescriptor> descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor,
java.util.Map<java.lang.String,java.lang.Object> attributes,
LinkDescriptor... descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor,
java.util.Map<java.lang.String,java.lang.Object> attributes,
java.util.List<LinkDescriptor> descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
| Constructor and Description |
|---|
LinksSnippet(LinkExtractor linkExtractor,
java.util.List<LinkDescriptor> descriptors)
Creates a new
LinksSnippet that will extract links using the given
linkExtractor and document them using the given descriptors. |
LinksSnippet(LinkExtractor linkExtractor,
java.util.List<LinkDescriptor> descriptors,
boolean ignoreUndocumentedLinks)
Creates a new
LinksSnippet that will extract links using the given
linkExtractor and document them using the given descriptors. |
LinksSnippet(LinkExtractor linkExtractor,
java.util.List<LinkDescriptor> descriptors,
java.util.Map<java.lang.String,java.lang.Object> attributes)
Creates a new
LinksSnippet that will extract links using the given
linkExtractor and document them using the given descriptors. |
LinksSnippet(LinkExtractor linkExtractor,
java.util.List<LinkDescriptor> descriptors,
java.util.Map<java.lang.String,java.lang.Object> attributes,
boolean ignoreUndocumentedLinks)
Creates a new
LinksSnippet that will extract links using the given
linkExtractor and document them using the given descriptors. |