- removeHeaders(String...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors
-
Returns an OperationPreprocessor that will remove headers from the request
or response.
- 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 occurences of the given pattern with the
given replacement
- request(HttpMethod, String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
- request(HttpMethod, URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders
-
- RequestDocumentation - Class in org.springframework.restdocs.request
-
Static factory methods for documenting aspects of a request sent to a RESTful API.
- requestFields(FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a handler that will produce a snippet documenting the fields of the API
call's request.
- requestFields(Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a handler that will produce a snippet documenting the fields of the API
call's request.
- 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>, 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.
- requestParameters(ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a snippet that will document the request parameters from the API call's
request.
- requestParameters(Map<String, Object>, ParameterDescriptor...) - Static method in class org.springframework.restdocs.request.RequestDocumentation
-
Returns a snippet that will document the request parameters from the API call'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 given descriptors.
- 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 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
-
- resolveFile(String, String, RestDocumentationContext) - Method in class org.springframework.restdocs.snippet.StandardWriterResolver
-
- 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
-
- 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
-
- 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.
- responseFields(FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a handler that will produce a snippet documenting the fields of the API
call's response.
- responseFields(Map<String, Object>, FieldDescriptor...) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation
-
Returns a handler that will produce a snippet documenting the fields of the API
call's response.
- 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>, 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.
- RestDocumentation - Class in org.springframework.restdocs
-
A JUnit TestRule used to bootstrap the generation of REST documentation from
JUnit tests.
- RestDocumentation(String) - Constructor for class org.springframework.restdocs.RestDocumentation
-
Creates a new RestDocumentation instance that will generate snippets to the
given outputDirectory
- RestDocumentationContext - Class in org.springframework.restdocs
-
RestDocumentationContext encapsulates the context in which the documentation of
a RESTful API is being performed.
- RestDocumentationContext(Class<?>, String, File) - Constructor for class org.springframework.restdocs.RestDocumentationContext
-
Creates a new RestDocumentationContext for a test on the given
testClass with given testMethodName that will generate
documentation to the given outputDirectory.
- RestDocumentationContextPlaceholderResolver - Class in org.springframework.restdocs.snippet
-
- RestDocumentationContextPlaceholderResolver(RestDocumentationContext) - Constructor for class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver
-
Creates a new placeholder resolver that will resolve placeholders using the given
context.
- RestDocumentationMockMvcConfigurer - Class in org.springframework.restdocs.mockmvc
-
- 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.