A B C D E F G H I J K L M O P Q R S T V W

A

AbstractConfigurer - Class in org.springframework.restdocs.config

Abstract configurer that declares methods that are internal to the documentation configuration implementation.

AbstractConfigurer() - Constructor for class org.springframework.restdocs.config.AbstractConfigurer

AbstractDescriptor<T extends AbstractDescriptor<T>> - Class in org.springframework.restdocs.snippet

Base class for descriptors.

AbstractDescriptor() - Constructor for class org.springframework.restdocs.snippet.AbstractDescriptor

AbstractFieldsSnippet - Class in org.springframework.restdocs.payload

Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response fields.

AbstractFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.payload.AbstractFieldsSnippet

Deprecated.

since 1.1 in favor of AbstractFieldsSnippet.AbstractFieldsSnippet(String, List, Map, boolean)

AbstractFieldsSnippet(String, List<FieldDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.payload.AbstractFieldsSnippet

Creates a new AbstractFieldsSnippet that will produce a snippet named <type>-fields.

AbstractHeadersSnippet - Class in org.springframework.restdocs.headers

Abstract TemplatedSnippet subclass that provides a base for snippets that document a RESTful resource's request or response headers.

AbstractHeadersSnippet(String, List<HeaderDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.headers.AbstractHeadersSnippet

Creates a new AbstractHeadersSnippet that will produce a snippet named <type>-headers.

AbstractNestedConfigurer<PARENT> - Class in org.springframework.restdocs.config

Base class for NestedConfigurer implementations.

AbstractNestedConfigurer(PARENT) - Constructor for class org.springframework.restdocs.config.AbstractNestedConfigurer

Creates a new AbstractNestedConfigurer with the given parent.

AbstractParametersSnippet - Class in org.springframework.restdocs.request

Abstract TemplatedSnippet subclass that provides a base for snippets that document parameters from a request sent to a RESTful resource.

AbstractParametersSnippet(String, List<ParameterDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.request.AbstractParametersSnippet

Deprecated.

since 1.1 in favour of AbstractParametersSnippet.AbstractParametersSnippet(String, List, Map, boolean)

AbstractParametersSnippet(String, List<ParameterDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.request.AbstractParametersSnippet

Creates a new AbstractParametersSnippet that will produce a snippet with the given snippetName that will document parameters using the given descriptors.

add(String, String) - Method in class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor

Adds a parameter with the given name and value.

addSnippets(Snippet...) - Method in class org.springframework.restdocs.generate.RestDocumentationGenerator

Deprecated.

since 1.1 in favor of RestDocumentationGenerator.withSnippets(Snippet...)

afterTest() - Method in class org.springframework.restdocs.ManualRestDocumentation

Notification that a test has completed.

and() - Method in class org.springframework.restdocs.config.AbstractNestedConfigurer

and(HeaderDescriptor...) - Method in class org.springframework.restdocs.headers.RequestHeadersSnippet

Returns a new RequestHeadersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(List<HeaderDescriptor>) - Method in class org.springframework.restdocs.headers.RequestHeadersSnippet

Returns a new RequestHeadersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(HeaderDescriptor...) - Method in class org.springframework.restdocs.headers.ResponseHeadersSnippet

Returns a new ResponseHeadersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(List<HeaderDescriptor>) - Method in class org.springframework.restdocs.headers.ResponseHeadersSnippet

Returns a new ResponseHeadersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(LinkDescriptor...) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet

Returns a new LinksSnippet configured with this snippet's link extractor and attributes, and its descriptors combined with the given additionalDescriptors.

and(List<LinkDescriptor>) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet

Returns a new LinksSnippet configured with this snippet's link extractor and attributes, and its descriptors combined with the given additionalDescriptors.

and(FieldDescriptor...) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(FieldDescriptor...) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(ParameterDescriptor...) - Method in class org.springframework.restdocs.request.PathParametersSnippet

Returns a new PathParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(List<ParameterDescriptor>) - Method in class org.springframework.restdocs.request.PathParametersSnippet

Returns a new PathParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(ParameterDescriptor...) - Method in class org.springframework.restdocs.request.RequestParametersSnippet

Returns a new RequestParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(List<ParameterDescriptor>) - Method in class org.springframework.restdocs.request.RequestParametersSnippet

Returns a new RequestParametersSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(RequestPartDescriptor...) - Method in class org.springframework.restdocs.request.RequestPartsSnippet

Returns a new RequestPartsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

and(List<RequestPartDescriptor>) - Method in class org.springframework.restdocs.request.RequestPartsSnippet

Returns a new RequestPartsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

andWithPrefix(String, FieldDescriptor...) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

andWithPrefix(String, List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

Returns a new RequestFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

andWithPrefix(String, FieldDescriptor...) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

andWithPrefix(String, List<FieldDescriptor>) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

Returns a new ResponseFieldsSnippet configured with this snippet's attributes and its descriptors combined with the given additionalDescriptors.

apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.config.AbstractConfigurer

Applies the configurer to the given configuration.

apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer

Applies this configurer to the given configuration within the given context.

apply(Map<String, Object>, RestDocumentationContext) - Method in class org.springframework.restdocs.config.SnippetConfigurer

apply(Statement, Description) - Method in class org.springframework.restdocs.JUnitRestDocumentation

apply(Statement, Description) - Method in class org.springframework.restdocs.RestDocumentation

Deprecated.

applyPathPrefix(String, List<FieldDescriptor>) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation

Creates a copy of the given descriptors with the given pathPrefix applied to their paths.

asciidoctor() - Static method in class org.springframework.restdocs.templates.TemplateFormats

Returns the Asciidoctor template format with the ID asciidoctor and the file extension adoc.

AsciidoctorTableCellContentLambda - Class in org.springframework.restdocs.templates.mustache

A Mustache.Lambda that escapes | characters so that the do not break the table's formatting.

AsciidoctorTableCellContentLambda() - Constructor for class org.springframework.restdocs.templates.mustache.AsciidoctorTableCellContentLambda

atomLinks() - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation

Returns a LinkExtractor capable of extracting links in Atom format where the links are found in an array named links.

Attribute(String, Object) - Constructor for class org.springframework.restdocs.snippet.Attributes.Attribute

Creates a new attribute with the given key and value.

ATTRIBUTE_NAME_DEFAULT_SNIPPETS - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator

Name of the operation attribute used to hold the List of default snippets.

ATTRIBUTE_NAME_URL_TEMPLATE - Static variable in class org.springframework.restdocs.generate.RestDocumentationGenerator

Name of the operation attribute used to hold the request's URL template.

attributes(Attributes.Attribute...) - Method in class org.springframework.restdocs.snippet.AbstractDescriptor

Adds the given attributes to the descriptor.

Attributes - Class in org.springframework.restdocs.snippet

A fluent API for building a map of attributes.

attributes(Attributes.Attribute...) - Static method in class org.springframework.restdocs.snippet.Attributes

Creates a Map of the given attributes.

Attributes.Attribute - Class in org.springframework.restdocs.snippet

An attribute (key-value pair).

Attributes.AttributeBuilder - Class in org.springframework.restdocs.snippet

A simple builder for an attribute (key-value pair).

B

beforeOperation() - Method in class org.springframework.restdocs.JUnitRestDocumentation

beforeOperation() - Method in class org.springframework.restdocs.ManualRestDocumentation

beforeOperation() - Method in class org.springframework.restdocs.RestDocumentation

Deprecated.

beforeOperation() - Method in interface org.springframework.restdocs.RestDocumentationContextProvider

Returns a RestDocumentationContext for the operation that is about to be performed.

beforeTest(Class<?>, String) - Method in class org.springframework.restdocs.ManualRestDocumentation

Notification that a test is about to begin.

C

camelCaseToKebabCase(String) - Method in class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver

Converts the given string from camelCase to kebab-case.

camelCaseToSnakeCase(String) - Method in class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver

Converts the given string from camelCase to snake_case.

CliDocumentation - Class in org.springframework.restdocs.cli

Static factory methods for documenting a RESTful API as if it were being driven using a command-line utility such as curl or HTTPie.

compileTemplate(String) - Method in class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

compileTemplate(String) - Method in interface org.springframework.restdocs.templates.TemplateEngine

Compiles the template at the given path.

Constraint - Class in org.springframework.restdocs.constraints

A constraint.

Constraint(String, Map<String, Object>) - Constructor for class org.springframework.restdocs.constraints.Constraint

Creates a new Constraint with the given name and configuration.

ConstraintDescriptionResolver - Interface in org.springframework.restdocs.constraints

Resolves a description for a Constraint.

ConstraintDescriptions - Class in org.springframework.restdocs.constraints

Provides access to descriptions of a class's constraints.

ConstraintDescriptions(Class<?>) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions

Create a new ConstraintDescriptions for the given clazz.

ConstraintDescriptions(Class<?>, ConstraintResolver) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions

Create a new ConstraintDescriptions for the given clazz.

ConstraintDescriptions(Class<?>, ConstraintDescriptionResolver) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions

Create a new ConstraintDescriptions for the given clazz.

ConstraintDescriptions(Class<?>, ConstraintResolver, ConstraintDescriptionResolver) - Constructor for class org.springframework.restdocs.constraints.ConstraintDescriptions

Create a new ConstraintDescriptions for the given clazz.

ConstraintResolver - Interface in org.springframework.restdocs.constraints

An abstraction for resolving a class's constraints.

ContentModifier - Interface in org.springframework.restdocs.operation.preprocess

A ContentModifier modifies the content of an OperationRequest or OperationResponse during the preprocessing that is performed prior to documentation generation.

ContentModifyingOperationPreprocessor - Class in org.springframework.restdocs.operation.preprocess

An OperationPreprocessor that applies a ContentModifier to the content of the request or response.

ContentModifyingOperationPreprocessor(ContentModifier) - Constructor for class org.springframework.restdocs.operation.preprocess.ContentModifyingOperationPreprocessor

Create a new ContentModifyingOperationPreprocessor that will apply the given contentModifier to the operation's request or response.

ConversionException - Exception in org.springframework.restdocs.operation

An exception that can be thrown by RequestConverter and ResponseConverter implementations to indicate that a failure has occurred during conversion.

ConversionException(Throwable) - Constructor for exception org.springframework.restdocs.operation.ConversionException

Creates a new ConversionException with the given cause.

ConversionException(String, Throwable) - Constructor for exception org.springframework.restdocs.operation.ConversionException

Creates a new ConversionException with the given message and cause.

convert(R) - Method in interface org.springframework.restdocs.operation.RequestConverter

Converts the given request into an OperationRequest.

convert(R) - Method in interface org.springframework.restdocs.operation.ResponseConverter

Converts the given response into an OperationResponse.

create(URI, HttpMethod, byte[], HttpHeaders, Parameters, Collection<OperationRequestPart>) - Method in class org.springframework.restdocs.operation.OperationRequestFactory

Creates a new OperationRequest.

create(String, String, byte[], HttpHeaders) - Method in class org.springframework.restdocs.operation.OperationRequestPartFactory

Creates a new OperationRequestPart.

create(HttpStatus, HttpHeaders, byte[]) - Method in class org.springframework.restdocs.operation.OperationResponseFactory

Creates a new OperationResponse.

create(RestDocumentationContext) - Method in interface org.springframework.restdocs.snippet.PlaceholderResolverFactory

Creates a new PropertyPlaceholderHelper.PlaceholderResolver using the given context.

create(RestDocumentationContext) - Method in class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolverFactory

createFrom(OperationRequest, byte[]) - Method in class org.springframework.restdocs.operation.OperationRequestFactory

Creates a new OperationRequest based on the given original but with the given newContent.

createFrom(OperationRequest, HttpHeaders) - Method in class org.springframework.restdocs.operation.OperationRequestFactory

Creates a new OperationRequest based on the given original but with the given newHeaders.

createFrom(OperationRequest, Parameters) - Method in class org.springframework.restdocs.operation.OperationRequestFactory

Creates a new OperationRequest based on the given original but with the given newParameters.

createFrom(OperationResponse, byte[]) - Method in class org.springframework.restdocs.operation.OperationResponseFactory

Creates a new OperationResponse based on the given original but with the given newContent.

createFrom(OperationResponse, HttpHeaders) - Method in class org.springframework.restdocs.operation.OperationResponseFactory

Creates a new OperationResponse based on the given original but with the given newHeaders.

createModel(Operation) - Method in class org.springframework.restdocs.cli.CurlRequestSnippet

createModel(Operation) - Method in class org.springframework.restdocs.cli.HttpieRequestSnippet

createModel(Operation) - Method in class org.springframework.restdocs.headers.AbstractHeadersSnippet

createModel(Operation) - Method in class org.springframework.restdocs.http.HttpRequestSnippet

createModel(Operation) - Method in class org.springframework.restdocs.http.HttpResponseSnippet

createModel(Operation) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet

createModel(Operation) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

createModel(Operation) - Method in class org.springframework.restdocs.request.AbstractParametersSnippet

createModel(Operation) - Method in class org.springframework.restdocs.request.PathParametersSnippet

createModel(Operation) - Method in class org.springframework.restdocs.request.RequestPartsSnippet

createModel(Operation) - Method in class org.springframework.restdocs.snippet.TemplatedSnippet

Create the model that should be used during template rendering to document the given operation.

createModelForDescriptor(HeaderDescriptor) - Method in class org.springframework.restdocs.headers.AbstractHeadersSnippet

Returns a model for the given descriptor.

createModelForDescriptor(LinkDescriptor) - Method in class org.springframework.restdocs.hypermedia.LinksSnippet

Returns a model for the given descriptor.

createModelForDescriptor(FieldDescriptor) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns a model for the given descriptor.

createModelForDescriptor(ParameterDescriptor) - Method in class org.springframework.restdocs.request.AbstractParametersSnippet

Returns a model for the given descriptor.

CurlDocumentation - Class in org.springframework.restdocs.curl

Deprecated.

Since 1.1 in favor of CliDocumentation.

curlRequest() - Static method in class org.springframework.restdocs.cli.CliDocumentation

Returns a new Snippet that will document the curl request for the API operation.

curlRequest(Map<String, Object>) - Static method in class org.springframework.restdocs.cli.CliDocumentation

Returns a new Snippet that will document the curl request for the API operation.

curlRequest() - Static method in class org.springframework.restdocs.curl.CurlDocumentation

Deprecated.

Since 1.1 in favor of CliDocumentation.curlRequest().

curlRequest(Map<String, Object>) - Static method in class org.springframework.restdocs.curl.CurlDocumentation

Deprecated.

Since 1.1 in favor of CliDocumentation.curlRequest(Map).

CurlRequestSnippet - Class in org.springframework.restdocs.cli

A Snippet that documents the curl command for a request.

CurlRequestSnippet() - Constructor for class org.springframework.restdocs.cli.CurlRequestSnippet

Creates a new CurlRequestSnippet with no additional attributes.

CurlRequestSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.cli.CurlRequestSnippet

Creates a new CurlRequestSnippet with the given additional attributes that will be included in the model during template rendering.

CurlRequestSnippet - Class in org.springframework.restdocs.curl

Deprecated.

Since 1.1 in favor of CurlRequestSnippet.

CurlRequestSnippet() - Constructor for class org.springframework.restdocs.curl.CurlRequestSnippet

Deprecated.

Since 1.1 in favor of CurlRequestSnippet.

CurlRequestSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.curl.CurlRequestSnippet

Deprecated.

Since 1.1 in favor of CurlRequestSnippet.

D

DEFAULT_SNIPPET_ENCODING - Static variable in class org.springframework.restdocs.config.SnippetConfigurer

The default encoding for documentation snippets.

DEFAULT_TEMPLATE_FORMAT - Static variable in class org.springframework.restdocs.config.SnippetConfigurer

The default format for documentation snippets.

description(Object) - Method in class org.springframework.restdocs.snippet.AbstractDescriptor

Specifies the description.

descriptionsForProperty(String) - Method in class org.springframework.restdocs.constraints.ConstraintDescriptions

Returns a list of the descriptions for the constraints on the given property.

document(Operation) - Method in interface org.springframework.restdocs.snippet.Snippet

Documents the call to the RESTful API described by the given operation.

document(Operation) - Method in class org.springframework.restdocs.snippet.TemplatedSnippet

E

equals(Object) - Method in class org.springframework.restdocs.hypermedia.Link

execute(Template.Fragment, Writer) - Method in class org.springframework.restdocs.templates.mustache.AsciidoctorTableCellContentLambda

extractActualHeaders(Operation) - Method in class org.springframework.restdocs.headers.AbstractHeadersSnippet

Extracts the names of the headers from the request or response of the given operation.

extractActualHeaders(Operation) - Method in class org.springframework.restdocs.headers.RequestHeadersSnippet

extractActualHeaders(Operation) - Method in class org.springframework.restdocs.headers.ResponseHeadersSnippet

extractActualParameters(Operation) - Method in class org.springframework.restdocs.request.AbstractParametersSnippet

Extracts the names of the parameters that were present in the given operation.

extractActualParameters(Operation) - Method in class org.springframework.restdocs.request.PathParametersSnippet

extractActualParameters(Operation) - Method in class org.springframework.restdocs.request.RequestParametersSnippet

extractLinks(OperationResponse) - Method in interface org.springframework.restdocs.hypermedia.LinkExtractor

Extract the links from the given response, returning a Map of links where the keys are the link rels.

F

FieldDescriptor - Class in org.springframework.restdocs.payload

A description of a field found in a request or response payload.

FieldDescriptor(String) - Constructor for class org.springframework.restdocs.payload.FieldDescriptor

Creates a new FieldDescriptor describing the field with the given path.

FieldDoesNotExistException - Exception in org.springframework.restdocs.payload

A FieldDoesNotExistException is thrown when a requested field does not exist in a payload.

FieldDoesNotExistException(JsonFieldPath) - Constructor for exception org.springframework.restdocs.payload.FieldDoesNotExistException

Creates a new FieldDoesNotExistException that indicates that the field with the given fieldPath does not exist.

FieldTypeRequiredException - Exception in org.springframework.restdocs.payload

A FieldTypeRequiredException is thrown when a field's type cannot be determined automatically and, therefore, must be explicitly provided.

FieldTypeRequiredException(String) - Constructor for exception org.springframework.restdocs.payload.FieldTypeRequiredException

Creates a new FieldTypeRequiredException indicating that a type is required for the reason described in the given message.

fieldWithPath(String) - Static method in class org.springframework.restdocs.payload.PayloadDocumentation

Creates a FieldDescriptor that describes a field with the given path.

findMissingHeaders(Operation) - Method in class org.springframework.restdocs.headers.AbstractHeadersSnippet

Finds the headers that are missing from the operation.

G

getAttributes() - Method in interface org.springframework.restdocs.operation.Operation

Returns a Map of attributes associated with the operation.

getAttributes() - Method in class org.springframework.restdocs.operation.StandardOperation

getAttributes() - Method in class org.springframework.restdocs.snippet.AbstractDescriptor

Returns the descriptor's attributes.

getAttributes() - Method in class org.springframework.restdocs.snippet.TemplatedSnippet

Returns the additional attributes that will be included in the model during template rendering.

getCompiler() - Method in class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

Returns the Mustache.Compiler used to compile Mustache templates.

getConfiguration() - Method in class org.springframework.restdocs.constraints.Constraint

Returns the configuration of the constraint.

getContent() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the content of the request.

getContent() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the contents of the part.

getContent() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the content of the response.

getContent(Operation) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns the content of the request or response extracted form the given operation.

getContent(Operation) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

getContent(Operation) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

getContentAsString() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the content of the request as a String.

getContentAsString() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the content of the part as a String.

getContentAsString() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the content of the response as a String.

getContentType(Operation) - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns the content type of the request or response extracted from the given operation.

getContentType(Operation) - Method in class org.springframework.restdocs.payload.RequestFieldsSnippet

getContentType(Operation) - Method in class org.springframework.restdocs.payload.ResponseFieldsSnippet

getContext() - Method in class org.springframework.restdocs.snippet.RestDocumentationContextPlaceholderResolver

Returns the RestDocumentationContext that should be used during placeholder resolution.

getDescription() - Method in class org.springframework.restdocs.snippet.AbstractDescriptor

Returns the description.

getDescriptorsByRel() - Method in class org.springframework.restdocs.hypermedia.LinksSnippet

Returns a Map of LinkDescriptors keyed by their rels.

getFieldDescriptors() - Method in class org.springframework.restdocs.payload.AbstractFieldsSnippet

Returns the list of FieldDescriptors that will be used to generate the documentation.

getFieldDescriptors() - Method in class org.springframework.restdocs.request.AbstractParametersSnippet

Deprecated.

since 1.1.0 in favor of AbstractParametersSnippet.getParameterDescriptors()

getFileExtension() - Method in interface org.springframework.restdocs.templates.TemplateFormat

Returns the file extension to use for files generated from templates in this format.

getHeaderDescriptors() - Method in class org.springframework.restdocs.headers.AbstractHeadersSnippet

Returns the list of HeaderDescriptors that will be used to generate the documentation.

getHeaders() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the headers that were included in the request.

getHeaders() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the part's headers.

getHeaders() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the headers in the response.

getHref() - Method in class org.springframework.restdocs.hypermedia.Link

Returns the link's href.

getId() - Method in interface org.springframework.restdocs.templates.TemplateFormat

Returns the id of this template format.

getKey() - Method in class org.springframework.restdocs.snippet.Attributes.Attribute

Returns the attribute's key.

getMethod() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the HTTP method of the request.

getName() - Method in class org.springframework.restdocs.constraints.Constraint

Returns the name of the constraint.

getName() - Method in class org.springframework.restdocs.headers.HeaderDescriptor

Returns the name for the header.

getName() - Method in interface org.springframework.restdocs.operation.Operation

Returns the name of the operation.

getName() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the name of the part.

getName() - Method in class org.springframework.restdocs.operation.StandardOperation

getName() - Method in class org.springframework.restdocs.request.ParameterDescriptor

Returns the name of the parameter being described by this descriptor.

getName() - Method in class org.springframework.restdocs.request.RequestPartDescriptor

Returns the name of the request part being described by this descriptor.

getOutputDirectory() - Method in class org.springframework.restdocs.RestDocumentationContext

Returns the output directory to which generated snippets should be written.

getParameterDescriptors() - Method in class org.springframework.restdocs.request.AbstractParametersSnippet

Returns a Map of ParameterDescriptors that will be used to generate the documentation key by their ParameterDescriptor.getName().

getParameters() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the request's parameters.

getParts() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the request's parts, provided that it is a multipart request.

getPath() - Method in class org.springframework.restdocs.payload.FieldDescriptor

Returns the path of the field described by this descriptor.

getRel() - Method in class org.springframework.restdocs.hypermedia.Link

Returns the link's rel.

getRel() - Method in class org.springframework.restdocs.hypermedia.LinkDescriptor

Returns the rel of the link described by this descriptor.

getRequest() - Method in interface org.springframework.restdocs.operation.Operation

Returns the request that was sent.

getRequest() - Method in class org.springframework.restdocs.operation.StandardOperation

getResponse() - Method in interface org.springframework.restdocs.operation.Operation

Returns the response that was received.

getResponse() - Method in class org.springframework.restdocs.operation.StandardOperation

getSnippetName() - Method in class org.springframework.restdocs.snippet.TemplatedSnippet

Returns the name of the snippet that will be created.

getStatus() - Method in interface org.springframework.restdocs.operation.OperationResponse

Returns the status of the response.

getStepCount() - Method in class org.springframework.restdocs.RestDocumentationContext

Returns the current step count.

getSubmittedFileName() - Method in interface org.springframework.restdocs.operation.OperationRequestPart

Returns the name of the file that is being uploaded in this part.

getTemplateResourceResolver() - Method in class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

Returns the TemplateResourceResolver used to resolve the template resources prior to compilation.

getTestClass() - Method in class org.springframework.restdocs.RestDocumentationContext

Returns the class whose tests are currently executing.

getTestMethodName() - Method in class org.springframework.restdocs.RestDocumentationContext

Returns the name of the test method that is currently executing.

getTitle() - Method in class org.springframework.restdocs.hypermedia.Link

Returns the link's title, or null if it does not have a title.

getType() - Method in class org.springframework.restdocs.payload.FieldDescriptor

Returns the type of the field described by this descriptor.

getUniqueParameters(URI) - Method in class org.springframework.restdocs.operation.Parameters

Returns a new Parameters containing only the parameters that do no appear in the query string of the given uri.

getUri() - Method in interface org.springframework.restdocs.operation.OperationRequest

Returns the request's URI.

getValue() - Method in class org.springframework.restdocs.snippet.Attributes.Attribute

Returns the attribute's value.

H

halLinks() - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation

Returns a LinkExtractor capable of extracting links in Hypermedia Application Language (HAL) format where the links are found in a map named _links.

handle(REQ, RESP, Map<String, Object>) - Method in class org.springframework.restdocs.generate.RestDocumentationGenerator

Handles the given request and response, producing documentation snippets for them using the given configuration.

hashCode() - Method in class org.springframework.restdocs.hypermedia.Link

HeaderDescriptor - Class in org.springframework.restdocs.headers

A description of a header found in a request or response.

HeaderDescriptor(String) - Constructor for class org.springframework.restdocs.headers.HeaderDescriptor

Creates a new HeaderDescriptor describing the header with the given name.

HeaderDocumentation - Class in org.springframework.restdocs.headers

Static factory methods for documenting a RESTful API's request and response headers.

headerWithName(String) - Static method in class org.springframework.restdocs.headers.HeaderDocumentation

Creates a HeaderDescriptor that describes a header with the given name.

HttpDocumentation - Class in org.springframework.restdocs.http

Static factory methods for documenting a RESTful API's HTTP requests.

httpieRequest() - Static method in class org.springframework.restdocs.cli.CliDocumentation

Returns a new Snippet that will document the HTTPie request for the API operation.

httpieRequest(Map<String, Object>) - Static method in class org.springframework.restdocs.cli.CliDocumentation

Returns a new Snippet that will document the HTTPie request for the API operation.

HttpieRequestSnippet - Class in org.springframework.restdocs.cli

A Snippet that documents the HTTPie command for a request.

HttpieRequestSnippet() - Constructor for class org.springframework.restdocs.cli.HttpieRequestSnippet

Creates a new HttpieRequestSnippet with no additional attributes.

HttpieRequestSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.cli.HttpieRequestSnippet

Creates a new HttpieRequestSnippet with the given additional attributes that will be included in the model during template rendering.

httpRequest() - Static method in class org.springframework.restdocs.http.HttpDocumentation

Returns a new Snippet that will document the HTTP request for the API operation.

httpRequest(Map<String, Object>) - Static method in class org.springframework.restdocs.http.HttpDocumentation

Returns a new Snippet that will document the HTTP request for the API operation.

HttpRequestSnippet - Class in org.springframework.restdocs.http

A Snippet that documents an HTTP request.

HttpRequestSnippet() - Constructor for class org.springframework.restdocs.http.HttpRequestSnippet

Creates a new HttpRequestSnippet with no additional attributes.

HttpRequestSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.http.HttpRequestSnippet

Creates a new HttpRequestSnippet with the given additional attributes that will be included in the model during template rendering.

httpResponse() - Static method in class org.springframework.restdocs.http.HttpDocumentation

Returns a Snippet that will document the HTTP response for the API operation.

httpResponse(Map<String, Object>) - Static method in class org.springframework.restdocs.http.HttpDocumentation

Returns a Snippet that will document the HTTP response for the API operation.

HttpResponseSnippet - Class in org.springframework.restdocs.http

A Snippet that documents an HTTP response.

HttpResponseSnippet() - Constructor for class org.springframework.restdocs.http.HttpResponseSnippet

Creates a new HttpResponseSnippet with no additional attributes.

HttpResponseSnippet(Map<String, Object>) - Constructor for class org.springframework.restdocs.http.HttpResponseSnippet

Creates a new HttpResponseSnippet with the given additional attributes that will be included in the model during template rendering.

HypermediaDocumentation - Class in org.springframework.restdocs.hypermedia

Static factory methods for documenting a RESTful API that utilizes Hypermedia.

I

IgnorableDescriptor<T extends IgnorableDescriptor<T>> - Class in org.springframework.restdocs.snippet

Base class for descriptors for items that can be ignored.

IgnorableDescriptor() - Constructor for class org.springframework.restdocs.snippet.IgnorableDescriptor

ignored() - Method in class org.springframework.restdocs.snippet.IgnorableDescriptor

Marks the described item as being ignored.

isIgnored() - Method in class org.springframework.restdocs.snippet.IgnorableDescriptor

Returns whether or not the item being described should be ignored and, therefore, should not be included in the documentation.

isOptional() - Method in class org.springframework.restdocs.headers.HeaderDescriptor

Returns true if the described header is optional, otherwise false.

isOptional() - Method in class org.springframework.restdocs.hypermedia.LinkDescriptor

Returns true if the described link is optional, otherwise false.

isOptional() - Method in class org.springframework.restdocs.payload.FieldDescriptor

Returns true if the described field is optional, otherwise false.

isOptional() - Method in class org.springframework.restdocs.request.ParameterDescriptor

Returns true if the described parameter is optional, otherwise false.

isOptional() - Method in class org.springframework.restdocs.request.RequestPartDescriptor

Returns true if the described request part is optional, otherwise false.

J

JsonFieldType - Enum in org.springframework.restdocs.payload

An enumeration of the possible types for a field in a JSON request or response payload.

JUnitRestDocumentation - Class in org.springframework.restdocs

A JUnit TestRule used to automatically manage the RestDocumentationContext.

JUnitRestDocumentation(String) - Constructor for class org.springframework.restdocs.JUnitRestDocumentation

Creates a new JUnitRestDocumentation instance that will generate snippets to the given outputDirectory.

K

key(String) - Static method in class org.springframework.restdocs.snippet.Attributes

Creates an attribute with the given key.

L

Link - Class in org.springframework.restdocs.hypermedia

Representation of a link used in a Hypermedia-based API.

Link(String, String) - Constructor for class org.springframework.restdocs.hypermedia.Link

Creates a new Link with the given rel and href.

Link(String, String, String) - Constructor for class org.springframework.restdocs.hypermedia.Link

Creates a new Link with the given rel, href, and title.

LinkDescriptor - Class in org.springframework.restdocs.hypermedia

A description of a link found in a hypermedia API.

LinkDescriptor(String) - Constructor for class org.springframework.restdocs.hypermedia.LinkDescriptor

Creates a new LinkDescriptor describing a link with the given rel.

LinkExtractor - Interface in org.springframework.restdocs.hypermedia

A LinkExtractor is used to extract links from a JSON response.

links(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.

links(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.

links(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.

links(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.

links(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.

links(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.

links(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.

links(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.

LinksSnippet - Class in org.springframework.restdocs.hypermedia

A Snippet that documents a RESTful resource's links.

LinksSnippet(LinkExtractor, List<LinkDescriptor>) - Constructor for class org.springframework.restdocs.hypermedia.LinksSnippet

Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.

LinksSnippet(LinkExtractor, List<LinkDescriptor>, boolean) - Constructor for class org.springframework.restdocs.hypermedia.LinksSnippet

Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.

LinksSnippet(LinkExtractor, List<LinkDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.hypermedia.LinksSnippet

Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.

LinksSnippet(LinkExtractor, List<LinkDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.hypermedia.LinksSnippet

Creates a new LinksSnippet that will extract links using the given linkExtractor and document them using the given descriptors.

linkWithRel(String) - Static method in class org.springframework.restdocs.hypermedia.HypermediaDocumentation

Creates a LinkDescriptor that describes a link with the given rel.

M

ManualRestDocumentation - Class in org.springframework.restdocs

ManualRestDocumentation is used to manually manage the RestDocumentationContext.

ManualRestDocumentation(String) - Constructor for class org.springframework.restdocs.ManualRestDocumentation

Creates a new ManualRestDocumentation instance that will generate snippets to the given outputDirectory.

markdown() - Static method in class org.springframework.restdocs.templates.TemplateFormats

Returns the Markdown template format with the ID markdown and the file extension md.

maskLinks() - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns an OperationPreprocessor that will mask the href of hypermedia links in the request or response.

maskLinks(String) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns an OperationPreprocessor that will mask the href of hypermedia links in the request or response.

ModelCreationException - Exception in org.springframework.restdocs.snippet

An exception that can be thrown by a TemplatedSnippet to indicate that a failure has occurred during model creation.

ModelCreationException(Throwable) - Constructor for exception org.springframework.restdocs.snippet.ModelCreationException

Creates a new ModelCreationException with the given cause.

ModelCreationException(String, Throwable) - Constructor for exception org.springframework.restdocs.snippet.ModelCreationException

Creates a new ModelCreationException with the given message and cause.

modifyContent(byte[], MediaType) - Method in interface org.springframework.restdocs.operation.preprocess.ContentModifier

Returns modified content based on the given originalContent.

modifyContent(byte[], MediaType) - Method in class org.springframework.restdocs.operation.preprocess.PrettyPrintingContentModifier

modifyParameters() - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns a ParametersModifyingOperationPreprocessor that can then be configured to modify the parameters of the request.

MustacheTemplate - Class in org.springframework.restdocs.templates.mustache

An adapter that exposes a compiled Mustache template as a Template.

MustacheTemplate(Template) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplate

Creates a new MustacheTemplate that adapts the given delegate.

MustacheTemplate(Template, Map<String, Object>) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplate

Creates a new MustacheTemplate that adapts the given delegate.

MustacheTemplateEngine - Class in org.springframework.restdocs.templates.mustache

A Mustache-based TemplateEngine implemented using JMustache.

MustacheTemplateEngine(TemplateResourceResolver) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

Creates a new MustacheTemplateEngine that will use the given templateResourceResolver to resolve template paths.

MustacheTemplateEngine(TemplateResourceResolver, Mustache.Compiler) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

Creates a new MustacheTemplateEngine that will use the given templateResourceResolver to resolve templates and the given compiler to compile them.

MustacheTemplateEngine(TemplateResourceResolver, Mustache.Compiler, Map<String, Object>) - Constructor for class org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

Creates a new MustacheTemplateEngine that will use the given templateResourceResolver to resolve templates and the given compiler to compile them.

O

Operation - Interface in org.springframework.restdocs.operation

Describes an operation performed on a RESTful service.

OperationPreprocessor - Interface in org.springframework.restdocs.operation.preprocess

An OperationPreprocessor processes the OperationRequest and OperationResponse of an Operation prior to it being documented.

OperationPreprocessorAdapter - Class in org.springframework.restdocs.operation.preprocess

An implementation of OperationPreprocessor that returns the request and response as-is.

OperationPreprocessorAdapter() - Constructor for class org.springframework.restdocs.operation.preprocess.OperationPreprocessorAdapter

OperationRequest - Interface in org.springframework.restdocs.operation

The request that was sent as part of performing an operation on a RESTful service.

OperationRequestFactory - Class in org.springframework.restdocs.operation

A factory for creating OperationRequests.

OperationRequestFactory() - Constructor for class org.springframework.restdocs.operation.OperationRequestFactory

OperationRequestPart - Interface in org.springframework.restdocs.operation

A part of a multipart request.

OperationRequestPartFactory - Class in org.springframework.restdocs.operation

A factory for creating OperationRequestParts.

OperationRequestPartFactory() - Constructor for class org.springframework.restdocs.operation.OperationRequestPartFactory

OperationRequestPreprocessor - Interface in org.springframework.restdocs.operation.preprocess

An OperationRequestPreprocessor is used to modify an OperationRequest prior to it being documented.

OperationResponse - Interface in org.springframework.restdocs.operation

The response that was received as part of performing an operation on a RESTful service.

OperationResponseFactory - Class in org.springframework.restdocs.operation

A factory for creating OperationResponses.

OperationResponseFactory() - Constructor for class org.springframework.restdocs.operation.OperationResponseFactory

OperationResponsePreprocessor - Interface in org.springframework.restdocs.operation.preprocess

An OperationRequestPreprocessor is used to modify an OperationRequest prior to it being documented.

optional() - Method in class org.springframework.restdocs.headers.HeaderDescriptor

Marks the header as optional.

optional() - Method in class org.springframework.restdocs.hypermedia.LinkDescriptor

Marks the link as optional.

optional() - Method in class org.springframework.restdocs.payload.FieldDescriptor

Marks the field as optional.

optional() - Method in class org.springframework.restdocs.request.ParameterDescriptor

Marks the parameter as optional.

optional() - Method in class org.springframework.restdocs.request.RequestPartDescriptor

Marks the request part as optional.

org.springframework.restdocs - package org.springframework.restdocs

Core Spring REST Docs classes.

org.springframework.restdocs.cli - package org.springframework.restdocs.cli

Documenting CLI commands required to make a request to a RESTful API.

org.springframework.restdocs.config - package org.springframework.restdocs.config

Classes for configuring Spring REST Docs.

org.springframework.restdocs.constraints - package org.springframework.restdocs.constraints

Documenting a RESTful API's constraints.

org.springframework.restdocs.curl - package org.springframework.restdocs.curl

Documenting the curl command required to make a request to a RESTful API.

org.springframework.restdocs.generate - package org.springframework.restdocs.generate

Classes that drive the generation of the documentation snippets.

org.springframework.restdocs.headers - package org.springframework.restdocs.headers

Documenting the headers of a RESTful API's requests and responses.

org.springframework.restdocs.http - package org.springframework.restdocs.http

Documenting the HTTP request sent to a RESTful API and the HTTP response that is returned.

org.springframework.restdocs.hypermedia - package org.springframework.restdocs.hypermedia

Documenting a RESTful API that uses hypermedia.

org.springframework.restdocs.operation - package org.springframework.restdocs.operation

Operation API that describes a request that was sent and the response that was received when calling a RESTful API.

org.springframework.restdocs.operation.preprocess - package org.springframework.restdocs.operation.preprocess

Support for preprocessing an operation prior to it being documented.

org.springframework.restdocs.payload - package org.springframework.restdocs.payload

Documenting the payload of a RESTful API's requests and responses.

org.springframework.restdocs.request - package org.springframework.restdocs.request

Documenting query and path parameters of requests sent to a RESTful API.

org.springframework.restdocs.snippet - package org.springframework.restdocs.snippet

Snippet generation.

org.springframework.restdocs.templates - package org.springframework.restdocs.templates

Template API used to render documentation snippets.

org.springframework.restdocs.templates.mustache - package org.springframework.restdocs.templates.mustache

JMustache-based implementation of the template API.

P

ParameterDescriptor - Class in org.springframework.restdocs.request

A descriptor of a request or path parameter.

ParameterDescriptor(String) - Constructor for class org.springframework.restdocs.request.ParameterDescriptor

Creates a new ParameterDescriptor describing the parameter with the given name.

Parameters - Class in org.springframework.restdocs.operation

The parameters received in a request.

Parameters() - Constructor for class org.springframework.restdocs.operation.Parameters

ParametersModifyingOperationPreprocessor - Class in org.springframework.restdocs.operation.preprocess

An OperationPreprocessor that can be used to modify a request's OperationRequest.getParameters() by adding, setting, and removing parameters.

ParametersModifyingOperationPreprocessor() - Constructor for class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor

parameterWithName(String) - Static method in class org.springframework.restdocs.request.RequestDocumentation

Creates a ParameterDescriptor that describes a request or path parameter with the given name.

parse(URI) - Method in class org.springframework.restdocs.operation.QueryStringParser

Parses the query string of the given uri and returns the resulting Parameters.

partWithName(String) - Static method in class org.springframework.restdocs.request.RequestDocumentation

Creates a RequestPartDescriptor that describes a request part with the given name.

pathParameters(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.

pathParameters(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.

pathParameters(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.

pathParameters(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.

PathParametersSnippet - Class in org.springframework.restdocs.request

A Snippet that documents the path parameters supported by a RESTful resource.

PathParametersSnippet(List<ParameterDescriptor>) - Constructor for class org.springframework.restdocs.request.PathParametersSnippet

Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.

PathParametersSnippet(List<ParameterDescriptor>, boolean) - Constructor for class org.springframework.restdocs.request.PathParametersSnippet

Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.

PathParametersSnippet(List<ParameterDescriptor>, Map<String, Object>) - Constructor for class org.springframework.restdocs.request.PathParametersSnippet

Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.

PathParametersSnippet(List<ParameterDescriptor>, Map<String, Object>, boolean) - Constructor for class org.springframework.restdocs.request.PathParametersSnippet

Creates a new PathParametersSnippet that will document the request's path parameters using the given descriptors.

PayloadDocumentation - Class in org.springframework.restdocs.payload

Static factory methods for documenting a RESTful API's request and response payloads.

PlaceholderResolverFactory - Interface in org.springframework.restdocs.snippet

A factory for creating PropertyPlaceholderHelper.PlaceholderResolver instances.

preprocess(OperationRequest) - Method in class org.springframework.restdocs.operation.preprocess.ContentModifyingOperationPreprocessor

preprocess(OperationResponse) - Method in class org.springframework.restdocs.operation.preprocess.ContentModifyingOperationPreprocessor

preprocess(OperationRequest) - Method in interface org.springframework.restdocs.operation.preprocess.OperationPreprocessor

Processes the given request.

preprocess(OperationResponse) - Method in interface org.springframework.restdocs.operation.preprocess.OperationPreprocessor

Processes the given response.

preprocess(OperationRequest) - Method in class org.springframework.restdocs.operation.preprocess.OperationPreprocessorAdapter

Returns the given request as-is.

preprocess(OperationResponse) - Method in class org.springframework.restdocs.operation.preprocess.OperationPreprocessorAdapter

Returns the given response as-is.

preprocess(OperationRequest) - Method in interface org.springframework.restdocs.operation.preprocess.OperationRequestPreprocessor

Processes and potentially modifies the given request before it is documented.

preprocess(OperationResponse) - Method in interface org.springframework.restdocs.operation.preprocess.OperationResponsePreprocessor

Processes and potentially modifies the given response before it is documented.

preprocess(OperationRequest) - Method in class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor

Preprocessors - Class in org.springframework.restdocs.operation.preprocess

Static factory methods for creating OperationPreprocessors that can be applied to an Operation's request or response before it is documented.

preprocessRequest(OperationPreprocessor...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns an OperationRequestPreprocessor that will preprocess the request by applying the given preprocessors to it.

preprocessResponse(OperationPreprocessor...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns an OperationResponsePreprocessor that will preprocess the response by applying the given preprocessors to it.

prettyPrint() - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns an OperationPreprocessor that will pretty print the content of the request or response.

PrettyPrintingContentModifier - Class in org.springframework.restdocs.operation.preprocess

A ContentModifier that modifies the content by pretty printing it.

PrettyPrintingContentModifier() - Constructor for class org.springframework.restdocs.operation.preprocess.PrettyPrintingContentModifier

Q

QueryStringParser - Class in org.springframework.restdocs.cli

Deprecated.

since 1.1.2 in favor of QueryStringParser

QueryStringParser() - Constructor for class org.springframework.restdocs.cli.QueryStringParser

Deprecated.

QueryStringParser - Class in org.springframework.restdocs.operation

A parser for the query string of a URI.

QueryStringParser() - Constructor for class org.springframework.restdocs.operation.QueryStringParser

R

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(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>, 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>, 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(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.

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>, 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.

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.

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>, 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.

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(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>, 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>, 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.

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.

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>, 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.

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.

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>, 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.

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(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(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.

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.ParametersModifyingOperationPreprocessor

Removes the given value from the parameter with the given name.

removeHeaders(String...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns an OperationPreprocessor that will remove any header from the request or response with a name that is equal to one of the given headersToRemove.

removeMatchingHeaders(String...) - Static method in class org.springframework.restdocs.operation.preprocess.Preprocessors

Returns an OperationPreprocessor that will remove any headers from the request or response with a name that matches one of the given headerNamePatterns regular expressions.

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.

RequestConverter<R> - Interface in org.springframework.restdocs.operation

A RequestConverter is used to convert an implementation-specific request into an OperationRequest.

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 Snippet that will document the fields of the API operations's request payload.

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>, 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>, 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.

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.

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.

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>, 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>, 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.

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.

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.

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>, 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.

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>, boolean) - 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.

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 given descriptors.

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.

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.

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>, 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.

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

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

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.

ResponseConverter<R> - Interface in org.springframework.restdocs.operation

A ResponseConverter is used to convert an implementation-specific response into an OperationResponse.

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(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(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.

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.

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.

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>, 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>, 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.

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.

RestDocumentation - Class in org.springframework.restdocs

Deprecated.

Since 1.1 in favor of JUnitRestDocumentation

RestDocumentation(String) - Constructor for class org.springframework.restdocs.RestDocumentation

Deprecated.

Creates a new RestDocumentation instance that will generate snippets to the given outputDirectory.

RestDocumentationConfigurer<S 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 - 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

Deprecated.

Since 1.1 in favor of ManualRestDocumentation.

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.

RestDocumentationGenerationException - Exception in org.springframework.restdocs.generate

An exception that can be thrown when a failure occurs during REST documentation generation.

RestDocumentationGenerationException(Throwable) - Constructor for exception org.springframework.restdocs.generate.RestDocumentationGenerationException

Creates a new RestDocumentationException with the given cause.

RestDocumentationGenerationException(String, Throwable) - Constructor for exception org.springframework.restdocs.generate.RestDocumentationGenerationException

Creates a new RestDocumentationException with the given message and 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>, 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>, OperationRequestPreprocessor, OperationResponsePreprocessor, Snippet...) - Constructor for class org.springframework.restdocs.generate.RestDocumentationGenerator

Creates a new RestDocumentationGenerator for the operation identified by the given identifier.

S

set(String, String...) - Method in class org.springframework.restdocs.operation.preprocess.ParametersModifyingOperationPreprocessor

Sets the parameter with the given name to have the given values.

setEncoding(String) - Method in class org.springframework.restdocs.snippet.StandardWriterResolver

Deprecated.

setEncoding(String) - Method in interface org.springframework.restdocs.snippet.WriterResolver

Deprecated.

since 1.1.0 in favour of configuring the encoding when to resolver is created

Snippet - Interface in org.springframework.restdocs.snippet

A Snippet is used to document aspects of a call to a RESTful API.

SnippetConfigurer<PARENT,TYPE> - Class in org.springframework.restdocs.config

A configurer that can be used to configure the generated documentation snippets.

SnippetConfigurer(PARENT) - Constructor for class org.springframework.restdocs.config.SnippetConfigurer

Creates a new SnippetConfigurer with the given parent.

SnippetException - Exception in org.springframework.restdocs.snippet

A RuntimeException thrown to indicate a problem with the generation of a documentation snippet.

SnippetException(String) - Constructor for exception org.springframework.restdocs.snippet.SnippetException

Creates a new SnippetException described by the given message.

snippets() - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer

Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.

StandardOperation - Class in org.springframework.restdocs.operation

Standard implementation of Operation.

StandardOperation(String, OperationRequest, OperationResponse, Map<String, Object>) - Constructor for class org.springframework.restdocs.operation.StandardOperation

Creates a new StandardOperation.

StandardTemplateResourceResolver - Class in org.springframework.restdocs.templates

Standard implementation of TemplateResourceResolver.

StandardTemplateResourceResolver() - Constructor for class org.springframework.restdocs.templates.StandardTemplateResourceResolver

Deprecated.

since 1.1.0 in favour of StandardTemplateResourceResolver.StandardTemplateResourceResolver(TemplateFormat)

StandardTemplateResourceResolver(TemplateFormat) - Constructor for class org.springframework.restdocs.templates.StandardTemplateResourceResolver

Creates a new StandardTemplateResourceResolver that will produce default template resources formatted with the given templateFormat.

StandardWriterResolver - Class in org.springframework.restdocs.snippet

Standard implementation of WriterResolver.

StandardWriterResolver(PropertyPlaceholderHelper.PlaceholderResolver) - Constructor for class org.springframework.restdocs.snippet.StandardWriterResolver

Deprecated.

since 1.1.0 in favor of StandardWriterResolver.StandardWriterResolver(PlaceholderResolverFactory, String, TemplateFormat)

StandardWriterResolver(PlaceholderResolverFactory, String, TemplateFormat) - Constructor for class org.springframework.restdocs.snippet.StandardWriterResolver

Creates a new StandardWriterResolver that will use a PropertyPlaceholderHelper.PlaceholderResolver created from the given placeholderResolverFactory to resolve any placeholders in the operationName.

T

Template - Interface in org.springframework.restdocs.templates

A compiled Template that can be rendered to a String.

TemplatedSnippet - Class in org.springframework.restdocs.snippet

Base class for a Snippet that is produced using a Template and TemplateEngine.

TemplatedSnippet(String, Map<String, Object>) - Constructor for class org.springframework.restdocs.snippet.TemplatedSnippet

Creates a new TemplatedSnippet that will produce a snippet with the given snippetName.

templateEngine(TemplateEngine) - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer

Configures the TemplateEngine that will be used for snippet rendering.

TemplateEngine - Interface in org.springframework.restdocs.templates

A TemplateEngine is used to render documentation snippets.

TemplateFormat - Interface in org.springframework.restdocs.templates

A TemplateFormat provides information about a particular template format, such as Asciidoctor or Markdown.

TemplateFormats - Class in org.springframework.restdocs.templates

An enumeration of the built-in formats for which templates are provuded.

TemplateResourceResolver - Interface in org.springframework.restdocs.templates

A TemplateResourceResolver is responsible for resolving a name for a template into a Resource from which the template can be read.

toQueryString() - Method in class org.springframework.restdocs.operation.Parameters

Converts the parameters to a query string suitable for use in a URI or the body of a form-encoded request.

toString() - Method in class org.springframework.restdocs.hypermedia.Link

toString() - Method in enum org.springframework.restdocs.payload.JsonFieldType

type(Object) - Method in class org.springframework.restdocs.payload.FieldDescriptor

Specifies the type of the field.

V

ValidatorConstraintResolver - Class in org.springframework.restdocs.constraints

A ConstraintResolver that uses a Bean Validation Validator to resolve constraints.

ValidatorConstraintResolver() - Constructor for class org.springframework.restdocs.constraints.ValidatorConstraintResolver

Creates a new ValidatorConstraintResolver that will use a Validator in its default configuration to resolve constraints.

ValidatorConstraintResolver(Validator) - Constructor for class org.springframework.restdocs.constraints.ValidatorConstraintResolver

Creates a new ValidatorConstraintResolver that will use the given Validator to resolve constraints.

value(Object) - Method in class org.springframework.restdocs.snippet.Attributes.AttributeBuilder

Configures the value of the attribute.

valueOf(String) - Static method in enum org.springframework.restdocs.payload.JsonFieldType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.springframework.restdocs.payload.JsonFieldType

Returns an array containing the constants of this enum type, in the order they are declared.

verificationFailed(Set<String>, Set<String>) - Method in class org.springframework.restdocs.request.AbstractParametersSnippet

Called when the documented parameters do not match the actual parameters.

verificationFailed(Set<String>, Set<String>) - Method in class org.springframework.restdocs.request.PathParametersSnippet

verificationFailed(Set<String>, Set<String>) - Method in class org.springframework.restdocs.request.RequestParametersSnippet

W

withAdditionalDefaults(Snippet...) - Method in class org.springframework.restdocs.config.SnippetConfigurer

Configures additional documentation snippets that will be produced by default.

withDefaults(Snippet...) - Method in class org.springframework.restdocs.config.SnippetConfigurer

Configures the documentation snippets that will be produced by default.

withEncoding(String) - Method in class org.springframework.restdocs.config.SnippetConfigurer

Configures any documentation snippets to be written using the given encoding.

withSnippets(Snippet...) - Method in class org.springframework.restdocs.generate.RestDocumentationGenerator

Creates a new RestDocumentationGenerator with the same configuration as this one other than its snippets.

withTemplateFormat(TemplateFormat) - Method in class org.springframework.restdocs.config.SnippetConfigurer

Configures the format of the documentation snippet templates.

writerResolver(WriterResolver) - Method in class org.springframework.restdocs.config.RestDocumentationConfigurer

Configures the WriterResolver that will be used to resolve a writer for a snippet.

WriterResolver - Interface in org.springframework.restdocs.snippet

A WriterResolver is used to access the Writer that should be used to write a snippet for an operation that is being documented.

A B C D E F G H I J K L M O P Q R S T V W