Class RestDocumentationFilter
java.lang.Object
org.springframework.restdocs.restassured.RestDocumentationFilter
- All Implemented Interfaces:
io.restassured.filter.Filter
A REST Assured
Filter
for documenting RESTful APIs.- Since:
- 1.2.0
- Author:
- Andy Wilkinson
-
Method Summary
Modifier and TypeMethodDescriptionfinal RestDocumentationFilter
Creates a newRestDocumentationFilter
that will produce documentation using the givensnippets
.final io.restassured.response.Response
filter
(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext context) getConfiguration
(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.filter.FilterContext context) Returns the configuration that should be used when calling the delgate.
-
Method Details
-
filter
public final io.restassured.response.Response filter(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext context) - Specified by:
filter
in interfaceio.restassured.filter.Filter
-
getConfiguration
protected Map<String,Object> getConfiguration(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.filter.FilterContext context) Returns the configuration that should be used when calling the delgate. The configuration is derived from the givenrequestSpec
andcontext
.- Parameters:
requestSpec
- the request specificationcontext
- the filter context- Returns:
- the configuration
-
document
Creates a newRestDocumentationFilter
that will produce documentation using the givensnippets
.- Parameters:
snippets
- the snippets- Returns:
- the new result handler
-