public class RestDocumentationFilter
extends java.lang.Object
implements io.restassured.filter.Filter
Filter
for documenting RESTful APIs.Modifier and Type | Method and Description |
---|---|
RestDocumentationFilter |
document(Snippet... snippets)
Creates a new
RestDocumentationFilter that will produce documentation using
the given snippets . |
io.restassured.response.Response |
filter(io.restassured.specification.FilterableRequestSpecification requestSpec,
io.restassured.specification.FilterableResponseSpecification responseSpec,
io.restassured.filter.FilterContext context) |
protected java.util.Map<java.lang.String,java.lang.Object> |
getConfiguration(io.restassured.specification.FilterableRequestSpecification requestSpec,
io.restassured.filter.FilterContext context)
Returns the configuration that should be used when calling the delgate.
|
public final io.restassured.response.Response filter(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext context)
filter
in interface io.restassured.filter.Filter
protected java.util.Map<java.lang.String,java.lang.Object> getConfiguration(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.filter.FilterContext context)
requestSpec
and context
.requestSpec
- the request specificationcontext
- the filter contextpublic final RestDocumentationFilter document(Snippet... snippets)
RestDocumentationFilter
that will produce documentation using
the given snippets
.snippets
- the snippets