Class RestAssuredRestDocumentationConfigurer
java.lang.Object
org.springframework.restdocs.config.RestDocumentationConfigurer<RestAssuredSnippetConfigurer,RestAssuredOperationPreprocessorsConfigurer,RestAssuredRestDocumentationConfigurer>
org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer
- All Implemented Interfaces:
io.restassured.filter.Filter
public final class RestAssuredRestDocumentationConfigurer
extends RestDocumentationConfigurer<RestAssuredSnippetConfigurer,RestAssuredOperationPreprocessorsConfigurer,RestAssuredRestDocumentationConfigurer>
implements io.restassured.filter.Filter
A REST Assured-specific
RestDocumentationConfigurer.- Since:
- 1.2.0
- Author:
- Andy Wilkinson, Filip Hrisafov
-
Method Summary
Modifier and TypeMethodDescriptionio.restassured.response.Responsefilter(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext filterContext) Returns anOperationPreprocessorsConfigurerthat can be used to configure the operation request and response preprocessors that will be used.snippets()Returns aSnippetConfigurerthat can be used to configure the snippets that will be generated.Methods inherited from class org.springframework.restdocs.config.RestDocumentationConfigurer
apply, templateEngine, writerResolver
-
Method Details
-
snippets
Description copied from class:RestDocumentationConfigurerReturns aSnippetConfigurerthat can be used to configure the snippets that will be generated.- Specified by:
snippetsin classRestDocumentationConfigurer<RestAssuredSnippetConfigurer,RestAssuredOperationPreprocessorsConfigurer, RestAssuredRestDocumentationConfigurer> - Returns:
- the snippet configurer
-
operationPreprocessors
Description copied from class:RestDocumentationConfigurerReturns anOperationPreprocessorsConfigurerthat can be used to configure the operation request and response preprocessors that will be used.- Specified by:
operationPreprocessorsin classRestDocumentationConfigurer<RestAssuredSnippetConfigurer,RestAssuredOperationPreprocessorsConfigurer, RestAssuredRestDocumentationConfigurer> - Returns:
- the operation preprocessors configurer
-
filter
public io.restassured.response.Response filter(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext filterContext) - Specified by:
filterin interfaceio.restassured.filter.Filter
-