com.atlassian.oai.validator.springmvc

Class OpenApiValidationService

java.lang.Object

com.atlassian.oai.validator.springmvc.OpenApiValidationService

public class OpenApiValidationService
extends Object

Constructor Summary

Constructors

Constructor and Description
OpenApiValidationService(org.springframework.core.io.support.EncodedResource specAsResource, org.springframework.web.util.UrlPathHelper urlPathHelper)
OpenApiValidationService(OpenApiInteractionValidator validator, org.springframework.web.util.UrlPathHelper urlPathHelper)

Method Summary

Modifier and Type	Method and Description
Request	buildRequest(javax.servlet.http.HttpServletRequest servletRequest)
Response	buildResponse(org.springframework.web.util.ContentCachingResponseWrapper servletResponse)
ValidationReport	validateRequest(Request request)
ValidationReport	validateResponse(javax.servlet.http.HttpServletRequest servletRequest, Response response)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiValidationService

public OpenApiValidationService(org.springframework.core.io.support.EncodedResource specAsResource,
                                org.springframework.web.util.UrlPathHelper urlPathHelper)
                         throws IOException

Throws:

IOException

OpenApiValidationService

public OpenApiValidationService(OpenApiInteractionValidator validator,
                                org.springframework.web.util.UrlPathHelper urlPathHelper)

Method Detail

buildRequest

public Request buildRequest(javax.servlet.http.HttpServletRequest servletRequest)
                     throws IOException

Parameters:

servletRequest - the HttpServletRequest

Returns:

the build Request created out of given HttpServletRequest

Throws:

IOException - if the request body can't be read

buildResponse

public Response buildResponse(org.springframework.web.util.ContentCachingResponseWrapper servletResponse)

Parameters:

servletResponse - the HttpServletResponse whose body is cached

Returns:

the build Response created out of given ContentCachingResponseWrapper

validateRequest

public ValidationReport validateRequest(Request request)

Parameters:

request - the Request to validate against the OpenAPI / Swagger specification

Returns:

the ValidationReport for the validated Request

validateResponse

public ValidationReport validateResponse(javax.servlet.http.HttpServletRequest servletRequest,
                                         Response response)

Parameters:

servletRequest - the HttpServletRequest to examine the api path to validate against

response - the Response to validate against the OpenAPI / Swagger specification

Returns:

the ValidationReport for the validated Request