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

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.

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.

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

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

patch(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PATCH request.

patch(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PATCH 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>, 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(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.

PayloadSubsectionExtractor<T extends PayloadSubsectionExtractor<T>> - Interface in org.springframework.restdocs.payload

Strategy interface for extracting a subsection of a payload.

PlaceholderResolverFactory - Interface in org.springframework.restdocs.snippet

A factory for creating PropertyPlaceholderHelper.PlaceholderResolver instances.

port(int) - Method in class org.springframework.restdocs.operation.preprocess.UriModifyingOperationPreprocessor

Modifies the URI to use the given port.

post(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a POST request.

post(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a POST request.

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

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

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

Processes the given request.

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

Returns the given request 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(OperationRequest) - Method in class org.springframework.restdocs.operation.preprocess.UriModifyingOperationPreprocessor

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

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

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

Processes the given response.

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

Returns the given response as-is.

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

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

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

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

put(String, Object...) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PUT request.

put(URI) - Static method in class org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders

Create a MockHttpServletRequestBuilder for a PUT request.

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