Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
R
- relaxedLinks(List<LinkDescriptor>) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API operation's response. - relaxedLinks(Map<String, Object>, List<LinkDescriptor>) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API call's response. - relaxedLinks(Map<String, Object>, LinkDescriptor...) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API call's response. - relaxedLinks(LinkDescriptor...) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API operation's response. - relaxedLinks(LinkExtractor, List<LinkDescriptor>) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API operation's response. - relaxedLinks(LinkExtractor, Map<String, Object>, List<LinkDescriptor>) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API operation's response. - relaxedLinks(LinkExtractor, Map<String, Object>, LinkDescriptor...) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API operation's response. - relaxedLinks(LinkExtractor, LinkDescriptor...) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation
-
Returns a new
Snippet
that will document the links in the API operation's response. - relaxedPathParameters(List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the path parameters from the API operation's request. - relaxedPathParameters(Map<String, Object>, List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the path parameters from the API operation's request. - relaxedPathParameters(Map<String, Object>, ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the path parameters from the API operation's request. - relaxedPathParameters(ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the path parameters from the API operation's request. - relaxedRequestFields(List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operations's request payload. - relaxedRequestFields(Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's request payload. - relaxedRequestFields(Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's request payload. - relaxedRequestFields(FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operations's request payload. - relaxedRequestFields(PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the subsection of the API operations's request payload extracted by the givensubsectionExtractor
. - relaxedRequestFields(PayloadSubsectionExtractor<?>, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor
. - relaxedRequestFields(PayloadSubsectionExtractor<?>, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor
. - relaxedRequestFields(PayloadSubsectionExtractor<?>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the subsection of the API operations's request payload extracted by the givensubsectionExtractor
. - relaxedRequestParameters(List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - relaxedRequestParameters(Map<String, Object>, List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - relaxedRequestParameters(Map<String, Object>, ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - relaxedRequestParameters(ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - relaxedRequestPartFields(String, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - relaxedRequestPartFields(String, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - relaxedRequestPartFields(String, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - relaxedRequestPartFields(String, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - relaxedRequestPartFields(String, PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - relaxedRequestPartFields(String, PayloadSubsectionExtractor<?>, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - relaxedRequestPartFields(String, PayloadSubsectionExtractor<?>, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - relaxedRequestPartFields(String, PayloadSubsectionExtractor<?>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - relaxedRequestParts(List<RequestPartDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - relaxedRequestParts(Map<String, Object>, List<RequestPartDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - relaxedRequestParts(Map<String, Object>, RequestPartDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - relaxedRequestParts(RequestPartDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - relaxedResponseFields(List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - relaxedResponseFields(Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - relaxedResponseFields(Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - relaxedResponseFields(FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - relaxedResponseFields(PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - relaxedResponseFields(PayloadSubsectionExtractor<?>, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - relaxedResponseFields(PayloadSubsectionExtractor<?>, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - relaxedResponseFields(PayloadSubsectionExtractor<?>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - remove(String) - Method in class org.springframework.restdocs.operation.preprocess.HeadersModifyingOperationPreprocessor
-
Removes the header with the given
name
. - remove(String) - Method in class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor
-
Removes the parameter with the given
name
. - remove(String, String) - Method in class org.springframework.restdocs.operation.preprocess.HeadersModifyingOperationPreprocessor
-
Removes the given
value
from the header with the givenname
. - remove(String, String) - Method in class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor
-
Removes the given
value
from the parameter with the givenname
. - removeHeaders(String...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Deprecated.
- removeMatching(String) - Method in class org.springframework.restdocs.operation.preprocess.HeadersModifyingOperationPreprocessor
-
Remove headers that match the given
namePattern
regular expression. - removeMatchingHeaders(String...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Deprecated.since 3.0.0 in favor of
Preprocessors.modifyHeaders()
andHeadersModifyingOperationPreprocessor.removeMatching(String)
- removePort() - Method in class org.springframework.restdocs.operation.preprocess.UriModifyingOperationPreprocessor
-
Removes the port from the URI.
- render(Map<String, Object>) - Method in class org.springframework.restdocs.templates.mustache.MustacheTemplate
- render(Map<String, Object>) - Method in interface org.springframework.restdocs.templates.Template
-
Renders the template to a
String
using the givencontext
for variable/property resolution. - replacePattern(Pattern, String) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Returns an
OperationPreprocessor
that will modify the content of the request or response by replacing occurrences of the givenpattern
with the givenreplacement
. - request(HttpMethod, String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilder
for a request with the given HTTP method. - request(HttpMethod, URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
Create a
MockHttpServletRequestBuilder
for a request with the given HTTP method. - requestBody() - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the body of the API operation's request payload. - requestBody(Map<String, Object>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the body of the API operation's request payload. - requestBody(PayloadSubsectionExtractor<?>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document a subsection of the body of the API operation's request payload. - requestBody(PayloadSubsectionExtractor<?>, Map<String, Object>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document a subsection of the body of the API operation's request payload. - RequestBodySnippet - Class in org.springframework.restdocs.payload
-
A
Snippet
that documents the body of a request. - RequestBodySnippet() - Constructor for class org.springframework.restdocs.payload.RequestBodySnippet
-
Creates a new
RequestBodySnippet
. - RequestBodySnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestBodySnippet
-
Creates a new
RequestBodySnippet
with the given additionalattributes
that will be included in the model during template rendering. - RequestBodySnippet(PayloadSubsectionExtractor<?>) - Constructor for class org.springframework.restdocs.payload.RequestBodySnippet
-
Creates a new
RequestBodySnippet
that will document the subsection of the request body extracted by the givensubsectionExtractor
. - RequestBodySnippet(PayloadSubsectionExtractor<?>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestBodySnippet
-
Creates a new
RequestBodySnippet
that will document the subsection of the request body extracted by the givensubsectionExtractor
. - RequestConverter<R> - Interface in org.springframework.restdocs.operation
-
A
RequestConverter
is used to convert an implementation-specific request into anOperationRequest
. - RequestCookie - Class in org.springframework.restdocs.operation
-
A representation of a Cookie received in a request.
- RequestCookie(String, String) - Constructor for class org.springframework.restdocs.operation.RequestCookie
-
Creates a new
RequestCookie
with the givenname
andvalue
. - RequestDocumentation - Class in org.springframework.restdocs.request
-
Static factory methods for documenting aspects of a request sent to a RESTful API.
- requestFields(List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operations's request payload. - requestFields(Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's request payload. - requestFields(Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's request payload. - requestFields(FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operations's request payload. - requestFields(PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields in the subsection of the API operations's request payload extracted by the givensubsectionExtractor
. - requestFields(PayloadSubsectionExtractor<?>, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor
. - requestFields(PayloadSubsectionExtractor<?>, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the subsection of the API operation's request payload extracted by the givensubsectionExtractor
. - requestFields(PayloadSubsectionExtractor<?>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the subsection of API operations's request payload extracted by the givensubsectionExtractor
. - RequestFieldsSnippet - Class in org.springframework.restdocs.payload
-
A
Snippet
that documents the fields in a request. - RequestFieldsSnippet(List<FieldDescriptor>) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the request using the givendescriptors
. - RequestFieldsSnippet(List<FieldDescriptor>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the request using the givendescriptors
. - RequestFieldsSnippet(List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the request using the givendescriptors
. - RequestFieldsSnippet(List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the request using the givendescriptors
. - RequestFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the subsection of the request extracted by the givensubsectionExtractor
using the givendescriptors
. - RequestFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the subsection of the request extracted by the givensubsectionExtractor
using the givendescriptors
. - RequestFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the subsection of the request extracted by the givensubsectionExtractor
using the givendescriptors
. - RequestFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the subsection of the request extracted by the givensubsectionExtractor
using the givendescriptors
. - requestHeaders(List<HeaderDescriptor>) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operation's request. - requestHeaders(Map<String, Object>, List<HeaderDescriptor>) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operations's request. - requestHeaders(Map<String, Object>, HeaderDescriptor...) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operations's request. - requestHeaders(HeaderDescriptor...) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operation's request. - RequestHeadersSnippet - Class in org.springframework.restdocs.headers
-
A
Snippet
that documents the headers in a request. - RequestHeadersSnippet(List<HeaderDescriptor>) - Constructor for class org.springframework.restdocs.headers.RequestHeadersSnippet
-
Creates a new
RequestHeadersSnippet
that will document the headers in the request using the givendescriptors
. - RequestHeadersSnippet(List<HeaderDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.headers.RequestHeadersSnippet
-
Creates a new
RequestHeadersSnippet
that will document the headers in the request using the givendescriptors
. - requestParameters(List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - requestParameters(Map<String, Object>, List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - requestParameters(Map<String, Object>, ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - requestParameters(ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parameters from the API operation's request. - RequestParametersSnippet - Class in org.springframework.restdocs.request
-
A
Snippet
that documents the request parameters supported by a RESTful resource. - RequestParametersSnippet(List<ParameterDescriptor>) - Constructor for class org.springframework.restdocs.request.RequestParametersSnippet
-
Creates a new
RequestParametersSnippet
that will document the request's parameters using the givendescriptors
. - RequestParametersSnippet(List<ParameterDescriptor>, boolean) - Constructor for class org.springframework.restdocs.request.RequestParametersSnippet
-
Creates a new
RequestParametersSnippet
that will document the request's parameters using the givendescriptors
. - RequestParametersSnippet(List<ParameterDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.request.RequestParametersSnippet
-
Creates a new
RequestParametersSnippet
that will document the request's parameters using the givendescriptors
. - RequestParametersSnippet(List<ParameterDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.request.RequestParametersSnippet
-
Creates a new
RequestParametersSnippet
that will document the request's parameters using the givendescriptors
. - requestPartBody(String) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the body of specified part of the API operation's request payload. - requestPartBody(String, Map<String, Object>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the body of specified part of the API operation's request payload. - requestPartBody(String, PayloadSubsectionExtractor<?>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document a subsection of the body of specified part of the API operation's request payload. - requestPartBody(String, PayloadSubsectionExtractor<?>, Map<String, Object>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document a subsection of the body of specified part of the API operation's request payload. - RequestPartBodySnippet - Class in org.springframework.restdocs.payload
-
A
Snippet
that documents the body of a request part. - RequestPartBodySnippet(String) - Constructor for class org.springframework.restdocs.payload.RequestPartBodySnippet
-
Creates a new
RequestPartBodySnippet
that will document the body of the request part with the givenpartName
. - RequestPartBodySnippet(String, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestPartBodySnippet
-
Creates a new
RequestPartBodySnippet
that will document the body of the request part with the givenpartName
. - RequestPartBodySnippet(String, PayloadSubsectionExtractor<?>) - Constructor for class org.springframework.restdocs.payload.RequestPartBodySnippet
-
Creates a new
RequestPartBodySnippet
that will document the subsection of the body of the request part with the givenpartName
extracted by the givensubsectionExtractor
. - RequestPartBodySnippet(String, PayloadSubsectionExtractor<?>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestPartBodySnippet
-
Creates a new
RequestPartBodySnippet
that will document the body of the request part with the givenpartName
. - RequestPartDescriptor - Class in org.springframework.restdocs.request
-
A descriptor of a request part.
- RequestPartDescriptor(String) - Constructor for class org.springframework.restdocs.request.RequestPartDescriptor
-
Creates a new
RequestPartDescriptor
describing the request part with the givenname
. - requestPartFields(String, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - requestPartFields(String, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - requestPartFields(String, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - requestPartFields(String, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the specifiedpart
of the API operations's request payload. - requestPartFields(String, PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - requestPartFields(String, PayloadSubsectionExtractor<?>, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - requestPartFields(String, PayloadSubsectionExtractor<?>, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - requestPartFields(String, PayloadSubsectionExtractor<?>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the specifiedpart
of the API operations's request payload. - RequestPartFieldsSnippet - Class in org.springframework.restdocs.payload
-
A
Snippet
that documents the fields in a request part. - RequestPartFieldsSnippet(String, List<FieldDescriptor>) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestPartFieldsSnippet
that will document the fields in the request part using the givendescriptors
. - RequestPartFieldsSnippet(String, List<FieldDescriptor>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestPartFieldsSnippet
that will document the fields in the request part using the givendescriptors
. - RequestPartFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the request using the givendescriptors
. - RequestPartFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestFieldsSnippet
that will document the fields in the request using the givendescriptors
. - RequestPartFieldsSnippet(String, PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestPartFieldsSnippet
that will document the fields in a subsection of the request part using the givendescriptors
. - RequestPartFieldsSnippet(String, PayloadSubsectionExtractor<?>, List<FieldDescriptor>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestPartFieldsSnippet
that will document the fields in a subsection the request part using the givendescriptors
. - RequestPartFieldsSnippet(String, PayloadSubsectionExtractor<?>, List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestPartFieldsSnippet
that will document the fields in a subsection of the request part using the givendescriptors
. - RequestPartFieldsSnippet(String, PayloadSubsectionExtractor<?>, List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.RequestPartFieldsSnippet
-
Creates a new
RequestPartFieldsSnippet
that will document the fields in a subsection of the request part using the givendescriptors
. - requestParts(List<RequestPartDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - requestParts(Map<String, Object>, List<RequestPartDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - requestParts(Map<String, Object>, RequestPartDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - requestParts(RequestPartDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a
Snippet
that will document the parts from the API operation's request. - RequestPartsSnippet - Class in org.springframework.restdocs.request
-
A
Snippet
that documents the request parts supported by a RESTful resource. - RequestPartsSnippet(List<RequestPartDescriptor>) - Constructor for class org.springframework.restdocs.request.RequestPartsSnippet
-
Creates a new
RequestPartsSnippet
that will document the request's parts using the givendescriptors
. - RequestPartsSnippet(List<RequestPartDescriptor>, boolean) - Constructor for class org.springframework.restdocs.request.RequestPartsSnippet
-
Creates a new
RequestPartsSnippet
that will document the request's parts using the givendescriptors
. - RequestPartsSnippet(List<RequestPartDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.request.RequestPartsSnippet
-
Creates a new
RequestPartsSnippet
that will document the request's parts using the givendescriptors
. - RequestPartsSnippet(List<RequestPartDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.request.RequestPartsSnippet
-
Creates a new
RequestPartsSnippet
that will document the request's parts using the givendescriptors
. - resolve(String, String, RestDocumentationContext) - Method in class org.springframework.restdocs.snippet.StandardWriterResolver
- resolve(String, String, RestDocumentationContext) - Method in interface org.springframework.restdocs.snippet.WriterResolver
-
Returns a writer that can be used to write the snippet with the given name for the operation with the given name.
- resolveDescription(Constraint) - Method in interface org.springframework.restdocs.constraints.ConstraintDescriptionResolver
-
Resolves the description for the given
constraint
. - resolveDescription(Constraint) - Method in class org.springframework.restdocs.constraints.ResourceBundleConstraintDescriptionResolver
- resolveFieldType(FieldDescriptor) - Method in interface org.springframework.restdocs.payload.FieldTypeResolver
-
Resolves the type of the field that is described by the given
fieldDescriptor
based on the content of the payload. - resolveForProperty(String, Class<?>) - Method in interface org.springframework.restdocs.constraints.ConstraintResolver
-
Resolves and returns the constraints for the given
property
on the givenclazz
. - resolveForProperty(String, Class<?>) - Method in class org.springframework.restdocs.constraints.ValidatorConstraintResolver
- resolveParameter(ParameterContext, ExtensionContext) - Method in class org.springframework.restdocs.RestDocumentationExtension
- resolvePlaceholder(String) - Method in class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver
- resolveTemplateResource(String) - Method in class org.springframework.restdocs.templates.StandardTemplateResourceResolver
- resolveTemplateResource(String) - Method in interface org.springframework.restdocs.templates.TemplateResourceResolver
-
Resolves a
Resource
for the template with the givenname
. - ResourceBundleConstraintDescriptionResolver - Class in org.springframework.restdocs.constraints
-
A
ConstraintDescriptionResolver
that resolves constraint descriptions from aResourceBundle
. - ResourceBundleConstraintDescriptionResolver() - Constructor for class org.springframework.restdocs.constraints.ResourceBundleConstraintDescriptionResolver
-
Creates a new
ResourceBundleConstraintDescriptionResolver
that will resolve descriptions by looking them up in a resource bundle with the base nameorg.springframework.restdocs.constraints.ConstraintDescriptions
in the default locale loaded using the thread context class loader. - ResourceBundleConstraintDescriptionResolver(ResourceBundle) - Constructor for class org.springframework.restdocs.constraints.ResourceBundleConstraintDescriptionResolver
-
Creates a new
ResourceBundleConstraintDescriptionResolver
that will resolve descriptions by looking them up in the givenresourceBundle
. - responseBody() - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the body of the API operation's response payload. - responseBody(Map<String, Object>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the body of the API operation's response payload. - responseBody(PayloadSubsectionExtractor<?>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document a subsection of the body of the API operation's response payload. - responseBody(PayloadSubsectionExtractor<?>, Map<String, Object>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document a subsection of the body of the API operation's response payload. - ResponseBodySnippet - Class in org.springframework.restdocs.payload
-
A
Snippet
that documents the body of a response. - ResponseBodySnippet() - Constructor for class org.springframework.restdocs.payload.ResponseBodySnippet
-
Creates a new
ResponseBodySnippet
. - ResponseBodySnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.ResponseBodySnippet
-
Creates a new
ResponseBodySnippet
with the given additionalattributes
that will be included in the model during template rendering. - ResponseBodySnippet(PayloadSubsectionExtractor<?>) - Constructor for class org.springframework.restdocs.payload.ResponseBodySnippet
-
Creates a new
ResponseBodySnippet
that will document the subsection of the response body extracted by the givensubsectionExtractor
. - ResponseBodySnippet(PayloadSubsectionExtractor<?>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.ResponseBodySnippet
-
Creates a new
ResponseBodySnippet
that will document the subsection of the response body extracted by the givensubsectionExtractor
. - ResponseConverter<R> - Interface in org.springframework.restdocs.operation
-
A
ResponseConverter
is used to convert an implementation-specific response into anOperationResponse
. - responseFields(List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - responseFields(Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - responseFields(Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - responseFields(FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of the API operation's response payload. - responseFields(PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - responseFields(PayloadSubsectionExtractor<?>, Map<String, Object>, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - responseFields(PayloadSubsectionExtractor<?>, Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - responseFields(PayloadSubsectionExtractor<?>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a
Snippet
that will document the fields of a subsection of the API operation's response payload. - ResponseFieldsSnippet - Class in org.springframework.restdocs.payload
-
A
Snippet
that documents the fields in a response. - ResponseFieldsSnippet(List<FieldDescriptor>) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in the response using the givendescriptors
. - ResponseFieldsSnippet(List<FieldDescriptor>, boolean) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in the response using the givendescriptors
. - ResponseFieldsSnippet(List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in the response using the givendescriptors
. - ResponseFieldsSnippet(List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in the response using the givendescriptors
. - ResponseFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in a subsection of the response using the givendescriptors
. - ResponseFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>, boolean) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in the subsection of the response using the givendescriptors
. - ResponseFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in a subsection of the response using the givendescriptors
. - ResponseFieldsSnippet(PayloadSubsectionExtractor<?>, List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.ResponseFieldsSnippet
-
Creates a new
ResponseFieldsSnippet
that will document the fields in a subsection of the response using the givendescriptors
. - responseHeaders(List<HeaderDescriptor>) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operation's response. - responseHeaders(Map<String, Object>, List<HeaderDescriptor>) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operations's response. - responseHeaders(Map<String, Object>, HeaderDescriptor...) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operations's response. - responseHeaders(HeaderDescriptor...) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation
-
Returns a new
Snippet
that will document the headers of the API operation's response. - ResponseHeadersSnippet - Class in org.springframework.restdocs.headers
-
A
Snippet
that documents the headers in a response. - ResponseHeadersSnippet(List<HeaderDescriptor>) - Constructor for class org.springframework.restdocs.headers.ResponseHeadersSnippet
-
Creates a new
ResponseHeadersSnippet
that will document the headers in the response using the givendescriptors
. - ResponseHeadersSnippet(List<HeaderDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.headers.ResponseHeadersSnippet
-
Creates a new
ResponseHeadersSnippet
that will document the headers in the response using the givendescriptors
. - RestAssuredOperationPreprocessorsConfigurer - Class in org.springframework.restdocs.restassured
-
A configurer that can be used to configure the operation preprocessors when using REST Assured.
- RestAssuredRestDocumentation - Class in org.springframework.restdocs.restassured
-
Static factory methods for documenting RESTful APIs using REST Assured.
- RestAssuredRestDocumentationConfigurer - Class in org.springframework.restdocs.restassured
-
A REST Assured-specific
RestDocumentationConfigurer
. - RestAssuredSnippetConfigurer - Class in org.springframework.restdocs.restassured
-
A configurer that can be used to configure the generated documentation snippets when using REST Assured.
- RestDocumentationConfigurer<S extends AbstractConfigurer,
P extends AbstractConfigurer, T> - Class in org.springframework.restdocs.config -
Abstract base class for the configuration of Spring REST Docs.
- RestDocumentationConfigurer() - Constructor for class org.springframework.restdocs.config.RestDocumentationConfigurer
- RestDocumentationContext - Interface in org.springframework.restdocs
-
RestDocumentationContext
encapsulates the context in which the documentation of a RESTful API is being performed. - RestDocumentationContextPlaceholderResolver - Class in org.springframework.restdocs.snippet
-
A
PropertyPlaceholderHelper.PlaceholderResolver
that resolves placeholders using aRestDocumentationContext
. - RestDocumentationContextPlaceholderResolver(RestDocumentationContext) - Constructor for class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver
-
Creates a new placeholder resolver that will resolve placeholders using the given
context
. - RestDocumentationContextPlaceholderResolverFactory - Class in org.springframework.restdocs.snippet
-
A
PlaceholderResolverFactory
that createsRestDocumentationContextPlaceholderResolver
instances. - RestDocumentationContextPlaceholderResolverFactory() - Constructor for class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory
- RestDocumentationContextProvider - Interface in org.springframework.restdocs
-
A
RestDocumentationContextProvider
is used to provide access to theRestDocumentationContext
. - RestDocumentationExtension - Class in org.springframework.restdocs
-
A JUnit Jupiter
Extension
used to automatically manage theRestDocumentationContext
. - RestDocumentationExtension() - Constructor for class org.springframework.restdocs.RestDocumentationExtension
-
Creates a new
RestDocumentationExtension
that will use the default output directory. - RestDocumentationExtension(String) - Constructor for class org.springframework.restdocs.RestDocumentationExtension
-
Creates a new
RestDocumentationExtension
that will use the givenoutputDirectory
. - RestDocumentationFilter - Class in org.springframework.restdocs.restassured
-
A REST Assured
Filter
for documenting RESTful APIs. - RestDocumentationGenerationException - Exception in org.springframework.restdocs.generate
-
An exception that can be thrown when a failure occurs during REST documentation generation.
- RestDocumentationGenerationException(String, Throwable) - Constructor for exception org.springframework.restdocs.generate.RestDocumentationGenerationException
-
Creates a new
RestDocumentationException
with the givenmessage
andcause
. - RestDocumentationGenerationException(Throwable) - Constructor for exception org.springframework.restdocs.generate.RestDocumentationGenerationException
-
Creates a new
RestDocumentationException
with the givencause
. - RestDocumentationGenerator<REQ,
RESP> - Class in org.springframework.restdocs.generate -
A
RestDocumentationGenerator
is used to generate documentation snippets from the request and response of an operation performed on a service. - RestDocumentationGenerator(String, RequestConverter<REQ>, ResponseConverter<RESP>, OperationRequestPreprocessor, OperationResponsePreprocessor, Snippet...) - Constructor for class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Creates a new
RestDocumentationGenerator
for the operation identified by the givenidentifier
. - RestDocumentationGenerator(String, RequestConverter<REQ>, ResponseConverter<RESP>, OperationRequestPreprocessor, Snippet...) - Constructor for class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Creates a new
RestDocumentationGenerator
for the operation identified by the givenidentifier
. - RestDocumentationGenerator(String, RequestConverter<REQ>, ResponseConverter<RESP>, OperationResponsePreprocessor, Snippet...) - Constructor for class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Creates a new
RestDocumentationGenerator
for the operation identified by the givenidentifier
. - RestDocumentationGenerator(String, RequestConverter<REQ>, ResponseConverter<RESP>, Snippet...) - Constructor for class org.springframework.restdocs.generate.RestDocumentationGenerator
-
Creates a new
RestDocumentationGenerator
for the operation identified by the givenidentifier
. - RestDocumentationRequestBuilders - Class in org.springframework.restdocs.mockmvc
-
A drop-in replacement for
MockMvcRequestBuilders
that captures a request's URL template and makes it available for documentation. - RestDocumentationResultHandler - Class in org.springframework.restdocs.mockmvc
-
A Spring MVC Test
ResultHandler
for documenting RESTful APIs.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Preprocessors.modifyHeaders()
andHeadersModifyingOperationPreprocessor.remove(String)