Package org.springframework.restdocs.restassured

Class RestAssuredSnippetConfigurer

java.lang.Object
org.springframework.restdocs.config.AbstractConfigurer
org.springframework.restdocs.config.AbstractNestedConfigurer<PARENT>
org.springframework.restdocs.config.SnippetConfigurer<RestAssuredRestDocumentationConfigurer,RestAssuredSnippetConfigurer>
org.springframework.restdocs.restassured.RestAssuredSnippetConfigurer
All Implemented Interfaces:
io.restassured.filter.Filter
public final class RestAssuredSnippetConfigurer extends org.springframework.restdocs.config.SnippetConfigurer<RestAssuredRestDocumentationConfigurer,RestAssuredSnippetConfigurer> implements io.restassured.filter.Filter
A configurer that can be used to configure the generated documentation snippets when using REST Assured.
Since:
1.2.0
Author:
Andy Wilkinson

  • Field Summary

    Fields inherited from class org.springframework.restdocs.config.SnippetConfigurer

    DEFAULT_SNIPPET_ENCODING, DEFAULT_TEMPLATE_FORMAT

  • 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 context)
     

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

    apply, withAdditionalDefaults, withDefaults, withEncoding, withTemplateFormat

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

    and

    Methods inherited from class java.lang.Object

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

  • Method Details

    • filter

      public io.restassured.response.Response filter(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext context)
      Specified by:
      filter in interface io.restassured.filter.Filter