com.atlassian.oai.validator.mockmvc

Class SwaggerMatchers

java.lang.Object

com.atlassian.oai.validator.mockmvc.SwaggerMatchers

public class SwaggerMatchers
extends Object

Factory for Swagger assertions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwaggerMatchers.SwaggerValidationException

Constructor Summary

Constructors

Constructor and Description
SwaggerMatchers()

Method Summary

Modifier and Type	Method and Description
org.springframework.test.web.servlet.ResultMatcher	isValid(String swaggerJsonUrlOrPayload) Assert the result can be validated against the Swagger JSON specification at the given location OR actual swagger JSON String payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwaggerMatchers

public SwaggerMatchers()

Method Detail

isValid

public org.springframework.test.web.servlet.ResultMatcher isValid(String swaggerJsonUrlOrPayload)

Assert the result can be validated against the Swagger JSON specification at the given location OR actual swagger JSON String payload.

The URL can be an absolute HTTP/HTTPS URL, a File URL or a classpath location (without the classpath: scheme).

For example:

     // Create from a publicly hosted HTTP location
     .createFor("http://api.myservice.com/swagger.json")

     // Create from a file on the local filesystem
     .createFor("file://Users/myuser/tmp/swagger.json");

     // Create from a classpath resource in the /api package
     .createFor("/api/swagger.json");

     // Create from a swagger JSON payload
     .createFor("{\"swagger\": \"2.0\", ...}")
 

Parameters:

swaggerJsonUrlOrPayload - The location of the Swagger JSON specification to use in the validator.