- AbstractDescriptor<T extends AbstractDescriptor<T>> - Class in org.springframework.restdocs.snippet
-
Base class for descriptors.
- AbstractDescriptor() - Constructor for class org.springframework.restdocs.snippet.AbstractDescriptor
-
- AbstractFieldsSnippet - Class in org.springframework.restdocs.payload
-
Abstract
TemplatedSnippet
subclass that provides a base for snippets that
document a RESTful resource's request or response fields.
- AbstractFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.AbstractFieldsSnippet
-
Creates a new AbstractFieldsSnippet
that will produce a snippet named
<type>-fields
.
- AbstractHeadersSnippet - Class in org.springframework.restdocs.headers
-
Abstract
TemplatedSnippet
subclass that provides a base for snippets that
document a RESTful resource's request or response headers.
- AbstractHeadersSnippet(String, List<HeaderDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.headers.AbstractHeadersSnippet
-
Creates a new AbstractHeadersSnippet
that will produce a snippet named
<type>-headers
.
- AbstractParametersSnippet - Class in org.springframework.restdocs.request
-
Abstract
TemplatedSnippet
subclass that provides a base for snippets that
document parameters from a request sent to a RESTful resource.
- AbstractParametersSnippet(String, List<ParameterDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.request.AbstractParametersSnippet
-
Creates a new AbstractParametersSnippet
that will produce a snippet with
the given snippetName
that will document parameters using the given
descriptors
.
- apply(Statement, Description) - Method in class org.springframework.restdocs.RestDocumentation
-
- atomLinks() - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a LinkExtractor
capable of extracting links in Atom format where
the links are found in an array named links
.
- Attribute(String, Object) - Constructor for class org.springframework.restdocs.snippet.Attributes.Attribute
-
Creates a new attribute with the given key
and value
.
- attributes(Attributes.Attribute...) - Method in class org.springframework.restdocs.snippet.AbstractDescriptor
-
Adds the given attributes
to the descriptor.
- Attributes - Class in org.springframework.restdocs.snippet
-
A fluent API for building a map of attributes.
- attributes(Attributes.Attribute...) - Static method in class org.springframework.restdocs.snippet.Attributes
-
Creates a Map
of the given attributes
.
- Attributes.Attribute - Class in org.springframework.restdocs.snippet
-
An attribute (key-value pair).
- Attributes.AttributeBuilder - Class in org.springframework.restdocs.snippet
-
A simple builder for an attribute (key-value pair).