Index

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

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.

CommandFormatter - Interface in org.springframework.restdocs.cli

Formatter for CLI commands such as those included in CurlRequestSnippet and HttpieRequestSnippet.

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<?>, ConstraintDescriptionResolver) - 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<?>, 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(String, Throwable) - Constructor for exception org.springframework.restdocs.operation.ConversionException

Creates a new ConversionException with the given message and cause.

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

Creates a new ConversionException with the given 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.

CookieDescriptor - Class in org.springframework.restdocs.cookies

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

CookieDescriptor(String) - Constructor for class org.springframework.restdocs.cookies.CookieDescriptor

Creates a new CookieDescriptor describing the cookie with the given name.

CookieDocumentation - Class in org.springframework.restdocs.cookies

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

cookieWithName(String) - Static method in class org.springframework.restdocs.cookies.CookieDocumentation

Creates a CookieDescriptor that describes a cookie with the given name.

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

Creates a new OperationRequestPart.

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

Creates a new OperationRequest.

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

Creates a new OperationRequest.

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

Creates a new OperationResponse without cookies.

create(HttpStatusCode, HttpHeaders, byte[], Collection<ResponseCookie>) - 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(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.cookies.AbstractCookiesSnippet

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

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(CookieDescriptor) - Method in class org.springframework.restdocs.cookies.AbstractCookiesSnippet

Returns a model for the given descriptor.

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.

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(Map<String, Object>, CommandFormatter) - Static method in class org.springframework.restdocs.cli.CliDocumentation

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

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

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

CurlRequestSnippet - Class in org.springframework.restdocs.cli

A Snippet that documents the curl command for a request.

CurlRequestSnippet(Map<String, Object>, CommandFormatter) - 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(CommandFormatter) - Constructor for class org.springframework.restdocs.cli.CurlRequestSnippet

Creates a new CurlRequestSnippet that will use the given commandFormatter to format the curl command.

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