guru.nidi.ramltester

Class RamlDefinition

java.lang.Object

guru.nidi.ramltester.RamlDefinition

public class RamlDefinition
extends Object

Constructor Summary

Constructors

Constructor and Description
RamlDefinition(CheckerConfig config)
RamlDefinition(org.raml.model.Raml raml, SchemaValidators schemaValidators)

Method Summary

Modifier and Type	Method and Description
RamlDefinition	assumingBaseUri(String baseUri)
RamlDefinition	assumingBaseUri(String baseUri, boolean includeServletPath)
RamlHttpClient	createHttpClient()
RamlHttpClient	createHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)
RestAssuredClient	createRestAssured()
RestAssuredClient	createRestAssured3()
RamlRestTemplate	createRestTemplate(org.springframework.http.client.ClientHttpRequestFactory requestFactory)
RamlRestTemplate	createRestTemplate(org.springframework.web.client.RestTemplate restTemplate)
RamlChecker	createTester()
CheckingWebTarget	createWebTarget(javax.ws.rs.client.WebTarget target)
RamlDefinition	failFast() Will throw a RamlViolationException in case there are errors on the RamlReport
RamlDefinition	failFast(boolean failFast)
org.raml.model.Raml	getRaml()
RamlDefinition	ignoringXheaders()
RamlDefinition	ignoringXheaders(boolean ignoreXheaders)
RamlDefinition	includeServletPath()
RamlDefinition	includeServletPath(boolean includeServletPath)
RamlMatcher	matches()
RamlReport	testAgainst(org.springframework.test.web.servlet.MvcResult mvcResult)
RamlReport	testAgainst(RamlRequest request, RamlResponse response)
RamlReport	testAgainst(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
RamlReport	validate()
RamlValidator	validator()

Methods inherited from class java.lang.Object

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

Constructor Detail

RamlDefinition

public RamlDefinition(org.raml.model.Raml raml,
                      SchemaValidators schemaValidators)

RamlDefinition

public RamlDefinition(CheckerConfig config)

Method Detail

assumingBaseUri

public RamlDefinition assumingBaseUri(String baseUri)

assumingBaseUri

public RamlDefinition assumingBaseUri(String baseUri,
                                      boolean includeServletPath)

ignoringXheaders

public RamlDefinition ignoringXheaders()

ignoringXheaders

public RamlDefinition ignoringXheaders(boolean ignoreXheaders)

includeServletPath

public RamlDefinition includeServletPath()

includeServletPath

public RamlDefinition includeServletPath(boolean includeServletPath)

failFast

public RamlDefinition failFast()

Will throw a RamlViolationException in case there are errors on the RamlReport

Returns:

RamlDefinition

failFast

public RamlDefinition failFast(boolean failFast)

getRaml

public org.raml.model.Raml getRaml()

testAgainst

public RamlReport testAgainst(RamlRequest request,
                              RamlResponse response)

testAgainst

public RamlReport testAgainst(org.springframework.test.web.servlet.MvcResult mvcResult)

testAgainst

public RamlReport testAgainst(javax.servlet.ServletRequest request,
                              javax.servlet.ServletResponse response,
                              javax.servlet.FilterChain chain)
                       throws IOException,
                              javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

matches

public RamlMatcher matches()

createRestTemplate

public RamlRestTemplate createRestTemplate(org.springframework.http.client.ClientHttpRequestFactory requestFactory)

createRestTemplate

public RamlRestTemplate createRestTemplate(org.springframework.web.client.RestTemplate restTemplate)

createHttpClient

public RamlHttpClient createHttpClient()

createHttpClient

public RamlHttpClient createHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)

createRestAssured

public RestAssuredClient createRestAssured()

createRestAssured3

public RestAssuredClient createRestAssured3()

createWebTarget

public CheckingWebTarget createWebTarget(javax.ws.rs.client.WebTarget target)

createTester

public RamlChecker createTester()

validator

public RamlValidator validator()

validate

public RamlReport validate()