D F G H M O P R S U

D

document(String, Snippet...) - Static method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentation

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

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

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

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

Creates a new RestDocumentationFilter that will produce documentation using the given snippets.

documentationConfiguration(RestDocumentationContextProvider) - Static method in class org.springframework.restdocs.restassured.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

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

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

G

getConfiguration(FilterableRequestSpecification, FilterContext) - Method in class org.springframework.restdocs.restassured.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

Modifies the URI to use the given host.

M

modifyUris() - Static method in class org.springframework.restdocs.restassured.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.

P

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

Modifies the URI to use the given port.

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

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

R

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

Removes the port from the URI.

RestAssuredPreprocessors - Class in org.springframework.restdocs.restassured.operation.preprocess

Static factory methods for creating OperationPreprocessors for use with REST Assured.

RestAssuredRestDocumentation - Class in org.springframework.restdocs.restassured

Static factory methods for documenting RESTful APIs using REST Assured.

RestAssuredRestDocumentationConfigurer - Class in org.springframework.restdocs.restassured

A REST Assured-specific RestDocumentationConfigurer.

RestAssuredSnippetConfigurer - Class in org.springframework.restdocs.restassured

A configurer that can be used to configure the generated documentation snippets when using REST Assured.

RestDocumentationFilter - Class in org.springframework.restdocs.restassured

A REST Assured Filter for documenting RESTful APIs.

S

scheme(String) - Method in class org.springframework.restdocs.restassured.operation.preprocess.UriModifyingOperationPreprocessor

Modifies the URI to use the given scheme.

snippets() - Method in class org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer

snippets(Snippet...) - Method in class org.springframework.restdocs.restassured.RestDocumentationFilter

Deprecated.

since 1.1 in favor of document(Snippet...)

U

UriModifyingOperationPreprocessor - Class in org.springframework.restdocs.restassured.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.restassured.operation.preprocess.UriModifyingOperationPreprocessor

D F G H M O P R S U