Skip navigation links
Spring REST Docs 1.2.2.RELEASE
D F G H M O P R S U 

D

document(String, Snippet...) - Static method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentation
Deprecated.
Documents the API call with the given identifier using the given snippets.
document(String, OperationRequestPreprocessor, Snippet...) - Static method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentation
Deprecated.
Documents the API call with the given identifier using the given snippets in addition to any default snippets.
document(String, OperationResponsePreprocessor, Snippet...) - Static method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentation
Deprecated.
Documents the API call with the given identifier using the given snippets in addition to any default snippets.
document(String, OperationRequestPreprocessor, OperationResponsePreprocessor, Snippet...) - Static method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentation
Deprecated.
Documents the API call with the given identifier using the given snippets in addition to any default snippets.
document(Snippet...) - Method in class org.springframework.restdocs.restassured.RestDocumentationFilter
Deprecated.
Creates a new RestDocumentationFilter that will produce documentation using the given snippets.
document(String, Snippet...) - Static method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentation
Documents the API call with the given identifier using the given snippets.
document(String, OperationRequestPreprocessor, Snippet...) - Static method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentation
Documents the API call with the given identifier using the given snippets in addition to any default snippets.
document(String, OperationResponsePreprocessor, Snippet...) - Static method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentation
Documents the API call with the given identifier using the given snippets in addition to any default snippets.
document(String, OperationRequestPreprocessor, OperationResponsePreprocessor, Snippet...) - Static method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentation
Documents the API call with the given identifier using the given snippets in addition to any default snippets.
document(Snippet...) - Method in class org.springframework.restdocs.restassured3.RestDocumentationFilter
Creates a new RestDocumentationFilter that will produce documentation using the given snippets.
documentationConfiguration(RestDocumentationContextProvider) - Static method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentation
Deprecated.
Provides access to a RestAssuredRestDocumentationConfigurer that can be used to configure Spring REST Docs using the given contextProvider.
documentationConfiguration(RestDocumentationContextProvider) - Static method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentation
Provides access to a RestAssuredRestDocumentationConfigurer that can be used to configure Spring REST Docs using the given contextProvider.

F

filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer
Deprecated.
 
filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured.RestAssuredSnippetConfigurer
Deprecated.
 
filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured.RestDocumentationFilter
Deprecated.
 
filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentationConfigurer
 
filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestAssuredSnippetConfigurer
 
filter(FilterableRequestSpecification, FilterableResponseSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestDocumentationFilter
 

G

getConfiguration(FilterableRequestSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured.RestDocumentationFilter
Deprecated.
Returns the configuration that should be used when calling the delgate.
getConfiguration(FilterableRequestSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured3.RestDocumentationFilter
Returns the configuration that should be used when calling the delgate.

H

host(String) - Method in class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor
Deprecated.
Modifies the URI to use the given host.
host(String) - Method in class org.springframework.restdocs.restassured3.operation.preprocess.UriModifyingOperationPreprocessor
Modifies the URI to use the given host.

M

modifyUris() - Static method in class org.springframework.restdocs.restassured.operation.preprocess.RestAssuredPreprocessors
Deprecated.
Returns a UriModifyingOperationPreprocessor that will modify URIs in the request or response by changing one or more of their host, scheme, and port.
modifyUris() - Static method in class org.springframework.restdocs.restassured3.operation.preprocess.RestAssuredPreprocessors
Returns a UriModifyingOperationPreprocessor that will modify URIs in the request or response by changing one or more of their host, scheme, and port.

O

org.springframework.restdocs.restassured - package org.springframework.restdocs.restassured
Core classes for using Spring REST Docs with REST Assured.
org.springframework.restdocs.restassured.operation.preprocess - package org.springframework.restdocs.restassured.operation.preprocess
REST Assured-specific support for preprocessing an operation prior to it being documented.
org.springframework.restdocs.restassured3 - package org.springframework.restdocs.restassured3
Core classes for using Spring REST Docs with REST Assured 3.
org.springframework.restdocs.restassured3.operation.preprocess - package org.springframework.restdocs.restassured3.operation.preprocess
REST Assured-specific support for preprocessing an operation prior to it being documented.

P

port(int) - Method in class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor
Deprecated.
Modifies the URI to use the given port.
port(int) - Method in class org.springframework.restdocs.restassured3.operation.preprocess.UriModifyingOperationPreprocessor
Modifies the URI to use the given port.
preprocess(OperationRequest) - Method in class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor
Deprecated.
 
preprocess(OperationResponse) - Method in class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor
Deprecated.
 
preprocess(OperationRequest) - Method in class org.springframework.restdocs.restassured3.operation.preprocess.UriModifyingOperationPreprocessor
 
preprocess(OperationResponse) - Method in class org.springframework.restdocs.restassured3.operation.preprocess.UriModifyingOperationPreprocessor
 

R

removePort() - Method in class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor
Deprecated.
Removes the port from the URI.
removePort() - Method in class org.springframework.restdocs.restassured3.operation.preprocess.UriModifyingOperationPreprocessor
Removes the port from the URI.
RestAssuredPreprocessors - Class in org.springframework.restdocs.restassured.operation.preprocess
Deprecated.
since 1.2.0 in favor of RestAssuredPreprocessors
RestAssuredPreprocessors - Class in org.springframework.restdocs.restassured3.operation.preprocess
Static factory methods for creating OperationPreprocessors for use with REST Assured 3.
RestAssuredRestDocumentation - Class in org.springframework.restdocs.restassured
Deprecated.
Since 1.2.0 in favor of RestAssuredRestDocumentation
RestAssuredRestDocumentation - Class in org.springframework.restdocs.restassured3
Static factory methods for documenting RESTful APIs using REST Assured 3.
RestAssuredRestDocumentationConfigurer - Class in org.springframework.restdocs.restassured
Deprecated.
RestAssuredRestDocumentationConfigurer - Class in org.springframework.restdocs.restassured3
A REST Assured 3-specific RestDocumentationConfigurer.
RestAssuredSnippetConfigurer - Class in org.springframework.restdocs.restassured
Deprecated.
since 1.2.0 in favor of RestAssuredSnippetConfigurer
RestAssuredSnippetConfigurer - Class in org.springframework.restdocs.restassured3
A configurer that can be used to configure the generated documentation snippets when using REST Assured 3.
RestDocumentationFilter - Class in org.springframework.restdocs.restassured
Deprecated.
since 1.2.0 in favor of RestDocumentationFilter
RestDocumentationFilter - Class in org.springframework.restdocs.restassured3
A REST Assured 3 Filter for documenting RESTful APIs.

S

scheme(String) - Method in class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor
Deprecated.
Modifies the URI to use the given scheme.
scheme(String) - Method in class org.springframework.restdocs.restassured3.operation.preprocess.UriModifyingOperationPreprocessor
Modifies the URI to use the given scheme.
snippets() - Method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer
Deprecated.
 
snippets(Snippet...) - Method in class org.springframework.restdocs.restassured.RestDocumentationFilter
Deprecated.
since 1.1 in favor of document(Snippet...)
snippets() - Method in class org.springframework.restdocs.restassured3.RestAssuredRestDocumentationConfigurer
 
snippets(Snippet...) - Method in class org.springframework.restdocs.restassured3.RestDocumentationFilter
Deprecated.

U

UriModifyingOperationPreprocessor - Class in org.springframework.restdocs.restassured.operation.preprocess
Deprecated.
since 1.2.0 in favor of UriModifyingOperationPreprocessor
UriModifyingOperationPreprocessor() - Constructor for class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor
Deprecated.
 
UriModifyingOperationPreprocessor - Class in org.springframework.restdocs.restassured3.operation.preprocess
An OperationPreprocessor that modifies URIs in the request and in the response by changing one or more of their host, scheme, and port.
UriModifyingOperationPreprocessor() - Constructor for class org.springframework.restdocs.restassured3.operation.preprocess.UriModifyingOperationPreprocessor
 
D F G H M O P R S U 
Skip navigation links
Spring REST Docs 1.2.2.RELEASE