RestDocumentationFilter
@Deprecated public class RestDocumentationFilter extends Object implements com.jayway.restassured.filter.Filter
Filter
for documenting RESTful APIs.Modifier and Type | Method and Description |
---|---|
RestDocumentationFilter |
document(Snippet... snippets)
Deprecated.
Creates a new
RestDocumentationFilter that will produce documentation using
the given snippets . |
com.jayway.restassured.response.Response |
filter(com.jayway.restassured.specification.FilterableRequestSpecification requestSpec,
com.jayway.restassured.specification.FilterableResponseSpecification responseSpec,
com.jayway.restassured.filter.FilterContext context)
Deprecated.
|
protected Map<String,Object> |
getConfiguration(com.jayway.restassured.specification.FilterableRequestSpecification requestSpec,
com.jayway.restassured.filter.FilterContext context)
Deprecated.
Returns the configuration that should be used when calling the delgate.
|
RestDocumentationFilter |
snippets(Snippet... snippets)
Deprecated.
since 1.1 in favor of
document(Snippet...) |
public final com.jayway.restassured.response.Response filter(com.jayway.restassured.specification.FilterableRequestSpecification requestSpec, com.jayway.restassured.specification.FilterableResponseSpecification responseSpec, com.jayway.restassured.filter.FilterContext context)
filter
in interface com.jayway.restassured.filter.Filter
protected Map<String,Object> getConfiguration(com.jayway.restassured.specification.FilterableRequestSpecification requestSpec, com.jayway.restassured.filter.FilterContext context)
requestSpec
and context
.requestSpec
- the request specificationcontext
- the filter context@Deprecated public final RestDocumentationFilter snippets(Snippet... snippets)
document(Snippet...)
snippets
such that they are documented when this result
handler is called.snippets
- the snippets to addRestDocumentationFilter
public final RestDocumentationFilter document(Snippet... snippets)
RestDocumentationFilter
that will produce documentation using
the given snippets
.snippets
- the snippets