Package | Description |
---|---|
org.springframework.restdocs.hypermedia |
Documenting a RESTful API that uses hypermedia.
|
Modifier and Type | Method and Description |
---|---|
LinksSnippet |
LinksSnippet.and(LinkDescriptor... additionalDescriptors)
Returns a new
LinksSnippet configured with this snippet's link extractor
and attributes, and its descriptors combined with the given
additionalDescriptors . |
LinksSnippet |
LinksSnippet.and(java.util.List<LinkDescriptor> additionalDescriptors)
Returns a new
LinksSnippet configured with this snippet's link extractor
and attributes, and its descriptors combined with the given
additionalDescriptors . |
static LinksSnippet |
HypermediaDocumentation.links(LinkDescriptor... descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
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.links(java.util.List<LinkDescriptor> descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.links(java.util.Map<java.lang.String,java.lang.Object> attributes,
LinkDescriptor... descriptors)
Returns a new
Snippet that will document the links in the API call's
response. |
static LinksSnippet |
HypermediaDocumentation.links(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 call's
response. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(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. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(java.util.List<LinkDescriptor> descriptors)
Returns a new
Snippet that will document the links in the API operation's
response. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(java.util.Map<java.lang.String,java.lang.Object> attributes,
LinkDescriptor... descriptors)
Returns a new
Snippet that will document the links in the API call's
response. |
static LinksSnippet |
HypermediaDocumentation.relaxedLinks(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 call's
response. |