R-Index (Spring REST Docs 3.0.4-SNAPSHOT API)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

R

relaxedFormParameters(List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the form parameters from the API operation's request.
relaxedFormParameters(Map<String, Object>, List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the form parameters from the API operation's request.
relaxedFormParameters(Map<String, Object>, ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the form parameters from the API operation's request.
relaxedFormParameters(ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the form parameters from the API operation's request.
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.
relaxedQueryParameters(List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the query parameters from the API operation's request.
relaxedQueryParameters(Map<String, Object>, List<ParameterDescriptor>) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the query parameters from the API operation's request.
relaxedQueryParameters(Map<String, Object>, ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the query parameters from the API operation's request.
relaxedQueryParameters(ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation: Returns a Snippet that will document the query parameters from the API operation's request.
relaxedRequestCookies(List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operation's request.
relaxedRequestCookies(Map<String, Object>, List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's request.
relaxedRequestCookies(Map<String, Object>, CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's request.
relaxedRequestCookies(CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of 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 given subsectionExtractor .
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 given subsectionExtractor.
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 given subsectionExtractor.
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 given subsectionExtractor .
relaxedRequestPartFields(String, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation: Returns a Snippet that will document the fields of the specified part 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 specified part 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 specified part 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 specified part 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 specified part 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 specified part 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 specified part 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 specified part 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.
relaxedResponseCookies(List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operation's response.
relaxedResponseCookies(Map<String, Object>, List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's response.
relaxedResponseCookies(Map<String, Object>, CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's response.
relaxedResponseCookies(CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operation's response.
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, String) - Method in class org.springframework.restdocs.operation.preprocess.HeadersModifyingOperationPreprocessor: Removes the given value from the header with the given name.
removeHeaders(String...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors: Deprecated.
since 3.0.0 in favor of Preprocessors.modifyHeaders() and HeadersModifyingOperationPreprocessor.remove(String)
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() and HeadersModifyingOperationPreprocessor.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 given context 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 given pattern with the given replacement.
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 additional attributes 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 given subsectionExtractor.
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 given subsectionExtractor.
RequestConverter<R> - Interface in org.springframework.restdocs.operation: A RequestConverter is used to convert an implementation-specific request into an OperationRequest.
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 given name and value.
requestCookies(List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operation's request.
requestCookies(Map<String, Object>, List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's request.
requestCookies(Map<String, Object>, CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's request.
requestCookies(CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operation's request.
RequestCookiesSnippet - Class in org.springframework.restdocs.cookies: A Snippet that documents the cookies in a request.
RequestCookiesSnippet(List<CookieDescriptor>) - Constructor for class org.springframework.restdocs.cookies.RequestCookiesSnippet: Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
RequestCookiesSnippet(List<CookieDescriptor>, boolean) - Constructor for class org.springframework.restdocs.cookies.RequestCookiesSnippet: Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
RequestCookiesSnippet(List<CookieDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.cookies.RequestCookiesSnippet: Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
RequestCookiesSnippet(List<CookieDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.cookies.RequestCookiesSnippet: Creates a new RequestCookiesSnippet that will document the cookies in the request using the given descriptors.
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 given subsectionExtractor .
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 given subsectionExtractor.
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 given subsectionExtractor.
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 given subsectionExtractor.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given subsectionExtractor using the given descriptors.
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 given subsectionExtractor using the given descriptors.
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 given subsectionExtractor using the given descriptors.
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 given subsectionExtractor using the given descriptors.
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 given descriptors.
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 given descriptors.
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 given partName.
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 given partName.
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 given partName extracted by the given subsectionExtractor.
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 given partName.
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 given name.
requestPartFields(String, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation: Returns a Snippet that will document the fields of the specified part 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 specified part 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 specified part 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 specified part 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 specified part 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 specified part 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 specified part 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 specified part 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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given clazz.
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 given name.
ResourceBundleConstraintDescriptionResolver - Class in org.springframework.restdocs.constraints: A ConstraintDescriptionResolver that resolves constraint descriptions from a ResourceBundle.
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 name org.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 given resourceBundle.
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 additional attributes 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 given subsectionExtractor.
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 given subsectionExtractor.
ResponseConverter<R> - Interface in org.springframework.restdocs.operation: A ResponseConverter is used to convert an implementation-specific response into an OperationResponse.
ResponseCookie - Class in org.springframework.restdocs.operation: A representation of a Cookie returned in a response.
ResponseCookie(String, String) - Constructor for class org.springframework.restdocs.operation.ResponseCookie: Creates a new ResponseCookie with the given name and value.
responseCookies(List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operation's response.
responseCookies(Map<String, Object>, List<CookieDescriptor>) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's response.
responseCookies(Map<String, Object>, CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operations's response.
responseCookies(CookieDescriptor...) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation: Returns a new Snippet that will document the cookies of the API operation's response.
ResponseCookiesSnippet - Class in org.springframework.restdocs.cookies: A Snippet that documents the cookies in a response.
ResponseCookiesSnippet(List<CookieDescriptor>) - Constructor for class org.springframework.restdocs.cookies.ResponseCookiesSnippet: Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.
ResponseCookiesSnippet(List<CookieDescriptor>, boolean) - Constructor for class org.springframework.restdocs.cookies.ResponseCookiesSnippet: Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.
ResponseCookiesSnippet(List<CookieDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.cookies.ResponseCookiesSnippet: Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.
ResponseCookiesSnippet(List<CookieDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.cookies.ResponseCookiesSnippet: Creates a new ResponseCookiesSnippet that will document the cookies in the response using the given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 given descriptors.
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 a RestDocumentationContext.
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 creates RestDocumentationContextPlaceholderResolver instances.
RestDocumentationContextPlaceholderResolverFactory() - Constructor for class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory
RestDocumentationContextProvider - Interface in org.springframework.restdocs: A RestDocumentationContextProvider is used to provide access to the RestDocumentationContext.
RestDocumentationExtension - Class in org.springframework.restdocs: A JUnit Jupiter Extension used to automatically manage the RestDocumentationContext.
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 given outputDirectory.
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 given message and cause.
RestDocumentationGenerationException(Throwable) - Constructor for exception org.springframework.restdocs.generate.RestDocumentationGenerationException: Creates a new RestDocumentationException with the given cause.
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 given identifier.
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 given identifier.
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 given identifier.
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 given identifier.
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.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form