Uses of Class
org.springframework.restdocs.hypermedia.LinkDescriptor
Packages that use LinkDescriptor
Package
Description
Documenting a RESTful API that uses hypermedia.
-
Uses of LinkDescriptor in org.springframework.restdocs.hypermedia
Methods in org.springframework.restdocs.hypermedia that return LinkDescriptorModifier and TypeMethodDescriptionstatic LinkDescriptorHypermediaDocumentation.linkWithRel(String rel) Creates aLinkDescriptorthat describes a link with the givenrel.final LinkDescriptorLinkDescriptor.optional()Marks the link as optional.Methods in org.springframework.restdocs.hypermedia that return types with arguments of type LinkDescriptorModifier and TypeMethodDescriptionprotected final Map<String,LinkDescriptor> LinksSnippet.getDescriptorsByRel()Methods in org.springframework.restdocs.hypermedia with parameters of type LinkDescriptorModifier and TypeMethodDescriptionfinal LinksSnippetLinksSnippet.and(LinkDescriptor... additionalDescriptors) Returns a newLinksSnippetconfigured with this snippet's link extractor and attributes, and its descriptors combined with the givenadditionalDescriptors.LinksSnippet.createModelForDescriptor(LinkDescriptor descriptor) Returns a model for the givendescriptor.static LinksSnippetHypermediaDocumentation.links(Map<String, Object> attributes, LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API call's response.static LinksSnippetHypermediaDocumentation.links(LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.links(LinkExtractor linkExtractor, Map<String, Object> attributes, LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.links(LinkExtractor linkExtractor, LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(Map<String, Object> attributes, LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API call's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor, Map<String, Object> attributes, LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor, LinkDescriptor... descriptors) Returns a newSnippetthat will document the links in the API operation's response.Method parameters in org.springframework.restdocs.hypermedia with type arguments of type LinkDescriptorModifier and TypeMethodDescriptionfinal LinksSnippetLinksSnippet.and(List<LinkDescriptor> additionalDescriptors) Returns a newLinksSnippetconfigured with this snippet's link extractor and attributes, and its descriptors combined with the givenadditionalDescriptors.static LinksSnippetHypermediaDocumentation.links(List<LinkDescriptor> descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetReturns a newSnippetthat will document the links in the API call's response.static LinksSnippetHypermediaDocumentation.links(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.links(LinkExtractor linkExtractor, Map<String, Object> attributes, List<LinkDescriptor> descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(List<LinkDescriptor> descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(Map<String, Object> attributes, List<LinkDescriptor> descriptors) Returns a newSnippetthat will document the links in the API call's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors) Returns a newSnippetthat will document the links in the API operation's response.static LinksSnippetHypermediaDocumentation.relaxedLinks(LinkExtractor linkExtractor, Map<String, Object> attributes, List<LinkDescriptor> descriptors) Returns a newSnippetthat will document the links in the API operation's response.Constructor parameters in org.springframework.restdocs.hypermedia with type arguments of type LinkDescriptorModifierConstructorDescriptionprotectedLinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors) Creates a newLinksSnippetthat will extract links using the givenlinkExtractorand document them using the givendescriptors.protectedLinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors, boolean ignoreUndocumentedLinks) Creates a newLinksSnippetthat will extract links using the givenlinkExtractorand document them using the givendescriptors.protectedLinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors, Map<String, Object> attributes) Creates a newLinksSnippetthat will extract links using the givenlinkExtractorand document them using the givendescriptors.protectedLinksSnippet(LinkExtractor linkExtractor, List<LinkDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedLinks) Creates a newLinksSnippetthat will extract links using the givenlinkExtractorand document them using the givendescriptors.