Uses of Interface
org.springframework.restdocs.hypermedia.LinkExtractor

Packages that use LinkExtractor

Package	Description
org.springframework.restdocs.hypermedia	Documenting a RESTful API that uses hypermedia.

Uses of LinkExtractor in org.springframework.restdocs.hypermedia

Methods in org.springframework.restdocs.hypermedia that return LinkExtractor

Modifier and Type	Method	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.

Methods in org.springframework.restdocs.hypermedia with parameters of type LinkExtractor

Modifier and Type	Method	Description
static LinksSnippet	HypermediaDocumentation.links(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors)	Returns a new Snippet that will document the links in the API operation's response.
static LinksSnippet	HypermediaDocumentation.links(LinkExtractor linkExtractor, Map<String,Object> attributes, List<LinkDescriptor> descriptors)	Returns a new Snippet that will document the links in the API operation's response.
static LinksSnippet	HypermediaDocumentation.links(LinkExtractor linkExtractor, Map<String,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, LinkDescriptor... descriptors)	Returns a new Snippet that will document the links in the API operation's response.
static LinksSnippet	HypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors)	Returns a new Snippet that will document the links in the API operation's response.
static LinksSnippet	HypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor, Map<String,Object> attributes, List<LinkDescriptor> descriptors)	Returns a new Snippet that will document the links in the API operation's response.
static LinksSnippet	HypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor, Map<String,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, LinkDescriptor... descriptors)	Returns a new Snippet that will document the links in the API operation's response.

Constructors in org.springframework.restdocs.hypermedia with parameters of type LinkExtractor

Modifier	Constructor	Description
protected	LinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors)	Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.
protected	LinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors, boolean ignoreUndocumentedLinks)	Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.
protected	LinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors, @Nullable Map<String,Object> attributes)	Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.
protected	LinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors, @Nullable Map<String,Object> attributes, boolean ignoreUndocumentedLinks)	Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.