Uses of Class
org.springframework.restdocs.hypermedia.LinkDescriptor

Packages that use LinkDescriptor

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

Uses of LinkDescriptor in org.springframework.restdocs.hypermedia

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

Modifier and Type	Method	Description
static LinkDescriptor	HypermediaDocumentation.linkWithRel(String rel)	Creates a LinkDescriptor that describes a link with the given rel.
final LinkDescriptor	LinkDescriptor.optional()	Marks the link as optional.

Methods in org.springframework.restdocs.hypermedia that return types with arguments of type LinkDescriptor

Modifier and Type	Method	Description
protected final Map<String,LinkDescriptor>	LinksSnippet.getDescriptorsByRel()	Returns a Map of LinkDescriptors keyed by their rels.

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

Modifier and Type	Method	Description
final 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.
protected Map<String,Object>	LinksSnippet.createModelForDescriptor(LinkDescriptor descriptor)	Returns a model for the given descriptor.
static LinksSnippet	HypermediaDocumentation.links(Map<String,Object> attributes, LinkDescriptor... descriptors)	Returns a new Snippet that will document the links in the API call's response.
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, 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(Map<String,Object> attributes, 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, 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.

Method parameters in org.springframework.restdocs.hypermedia with type arguments of type LinkDescriptor

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

Constructor parameters in org.springframework.restdocs.hypermedia with type arguments of type LinkDescriptor

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, 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, 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.