Package org.springframework.restdocs.restassured

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 Type	Method	Description
io.restassured.response.Response	filter(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext filterContext)
RestAssuredOperationPreprocessorsConfigurer	operationPreprocessors()	Returns an OperationPreprocessorsConfigurer that can be used to configure the operation request and response preprocessors that will be used.
RestAssuredSnippetConfigurer	snippets()	Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.

Methods inherited from class org.springframework.restdocs.config.RestDocumentationConfigurer

apply, templateEngine, writerResolver

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

snippets

public RestAssuredSnippetConfigurer snippets()

Description copied from class: RestDocumentationConfigurer

Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.

Specified by:

snippets in class RestDocumentationConfigurer<RestAssuredSnippetConfigurer,RestAssuredOperationPreprocessorsConfigurer,RestAssuredRestDocumentationConfigurer>

Returns:

the snippet configurer

operationPreprocessors

public RestAssuredOperationPreprocessorsConfigurer operationPreprocessors()

Description copied from class: RestDocumentationConfigurer

Returns an OperationPreprocessorsConfigurer that can be used to configure the operation request and response preprocessors that will be used.

Specified by:

operationPreprocessors in class RestDocumentationConfigurer<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:

filter in interface io.restassured.filter.Filter