com.atlassian.oai.validator.restassured

Class OpenApiValidationFilter

java.lang.Object

com.atlassian.oai.validator.restassured.OpenApiValidationFilter

All Implemented Interfaces:

io.restassured.filter.Filter

public class OpenApiValidationFilter
extends Object
implements io.restassured.filter.Filter

A Filter that performs OpenAPI / Swagger validation on a request/response interaction.

To use, simply add it as a filter to your rest-assured given-when-then interaction:

     private final OpenApiValidationFilter validationFilter = new OpenApiValidationFilter(SPEC_URL);
     ...
     given()
          .filter(validationFilter)
     .when()
          .get("/my/path")
     .then()
          .assertThat()
          .statusCode(200);
 

If validation fails, a OpenApiValidationFilter.OpenApiValidationException will be thrown describing the validation failure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenApiValidationFilter.OpenApiValidationException

Constructor Summary

Constructors

Constructor and Description
OpenApiValidationFilter(OpenApiInteractionValidator validator)
OpenApiValidationFilter(String specUrlOrDefinition)

Method Summary

Modifier and Type	Method and Description
io.restassured.response.Response	filter(io.restassured.specification.FilterableRequestSpecification requestSpec, io.restassured.specification.FilterableResponseSpecification responseSpec, io.restassured.filter.FilterContext ctx)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiValidationFilter

public OpenApiValidationFilter(String specUrlOrDefinition)

OpenApiValidationFilter

public OpenApiValidationFilter(OpenApiInteractionValidator validator)

Method Detail

filter

public io.restassured.response.Response filter(io.restassured.specification.FilterableRequestSpecification requestSpec,
                                               io.restassured.specification.FilterableResponseSpecification responseSpec,
                                               io.restassured.filter.FilterContext ctx)

Specified by:

filter in interface io.restassured.filter.Filter