Constructor Detail

• PactDslResponse

  PactDslResponse(ConsumerPactBuilder consumerPactBuilder, PactDslRequestWithPath request, PactDslRequestWithoutPath defaultRequestValues, PactDslResponse defaultResponseValues, List<String> comments, PactSpecVersion version)

Method Detail

• status

   final PactDslResponse status(Integer status)

  Response status code

  Parameters:

  status - HTTP status code

• headers

   final PactDslResponse headers(Map<String, String> headers)

  Response headers to return

  Provide the headers you want to validate, other headers will be ignored.

  Parameters:

  headers - key-value pairs of headers

• body

   final PactDslResponse body(String body)

  Response body to return

  Parameters:

  body - Response body in string form

• body

   final PactDslResponse body(String body, String contentType)

  Response body to return

  Parameters:

  body - body in string form

  contentType - the Content-Type response header value

• body

   final PactDslResponse body(String body, ContentType contentType)

  Response body to return

  Parameters:

  body - body in string form

  contentType - the Content-Type response header value

• body

   final PactDslResponse body(Supplier<String> body)

  The body of the request

  Parameters:

  body - Response body in Java Functional Interface Supplier that must return a string

• body

   final PactDslResponse body(Supplier<String> body, String contentType)

  The body of the request

  Parameters:

  body - Response body in Java Functional Interface Supplier that must return a string

  contentType - the Content-Type response header value

• body

   final PactDslResponse body(Supplier<String> body, ContentType contentType)

  The body of the request

  Parameters:

  body - Response body in Java Functional Interface Supplier that must return a string

  contentType - the Content-Type response header value

• body

   final PactDslResponse body(JSONObject body)

  Response body to return

  Parameters:

  body - Response body in JSON form

• body

   final PactDslResponse body(DslPart body)

  Response body to return

  Parameters:

  body - Response body built using the Pact body DSL

• body

   final PactDslResponse body(Document body)

  Response body to return

  Parameters:

  body - Response body as an XML Document

• body

   final PactDslResponse body(PactXmlBuilder xmlBuilder)

  XML Response body to return

  Parameters:

  xmlBuilder - XML Builder used to construct the XML document

• bodyWithSingleQuotes

   final PactDslResponse bodyWithSingleQuotes(String body)

  The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

  Parameters:

  body - Request body in string form

• bodyWithSingleQuotes

   final PactDslResponse bodyWithSingleQuotes(String body, String contentType)

  The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

  Parameters:

  body - Request body in string form

  contentType - the Content-Type response header value

• bodyWithSingleQuotes

   final PactDslResponse bodyWithSingleQuotes(String body, ContentType contentType)

  The body of the request with possible single quotes as delimiters and using QuoteUtil to convert single quotes to double quotes if required.

  Parameters:

  body - Request body in string form

  contentType - the Content-Type response header value

• withBinaryData

   final PactDslResponse withBinaryData(ByteArray example, String contentType)

  Response body as a binary data. It will match any expected bodies against the content type.

  Parameters:

  example - Example contents to use in the consumer test

  contentType - Content type of the data

• matchHeader

  @JvmOverloads() final PactDslResponse matchHeader(String header, String regexp, String headerExample)

  Match a response header. A random example header value will be generated from the provided regular expression if the example value is not provided.

  Parameters:

  header - Header to match

  regexp - Regular expression to match

  headerExample - Example value to use

• toPact

   final <P extends BasePact> P toPact(Class<P> pactClass)

  Terminates the DSL and builds a pact to represent the interactions

• toPact

   final RequestResponsePact toPact()

  Terminates the DSL and builds a pact to represent the interactions

• uponReceiving

   final PactDslRequestWithPath uponReceiving(String description)

  Description of the request that is expected to be received

  Parameters:

  description - request description

• given

   final PactDslWithState given(String state)

  Adds a provider state to this interaction

  Parameters:

  state - Description of the state

• given

   final PactDslWithState given(String state, Map<String, Object> params)

  Adds a provider state to this interaction

  Parameters:

  state - Description of the state

  params - Data parameters for this state

• headerFromProviderState

   final PactDslResponse headerFromProviderState(String name, String expression, String example)

  Adds a header that will have it's value injected from the provider state

  Parameters:

  name - Header Name

  expression - Expression to be evaluated from the provider state

  example - Example value to use in the consumer test

• matchSetCookie

   final PactDslResponse matchSetCookie(String cookie, String regex, String example)

  Match a set cookie header

  Parameters:

  cookie - Cookie name to match

  regex - Regex to match the cookie value with

  example - Example value

• comment

   final PactDslResponse comment(String comment)

  Adds a comment to this interaction

• informationStatus

   final PactDslResponse informationStatus()

  Match any HTTP Information response status (100-199)

• successStatus

   final PactDslResponse successStatus()

  Match any HTTP success response status (200-299)

• redirectStatus

   final PactDslResponse redirectStatus()

  Match any HTTP redirect response status (300-399)

• clientErrorStatus

   final PactDslResponse clientErrorStatus()

  Match any HTTP client error response status (400-499)

• serverErrorStatus

   final PactDslResponse serverErrorStatus()

  Match any HTTP server error response status (500-599)

• nonErrorStatus

   final PactDslResponse nonErrorStatus()

  Match any HTTP non-error response status (< 400)

• errorStatus

   final PactDslResponse errorStatus()

  Match any HTTP error response status (>= 400)

• statusCodes

   final PactDslResponse statusCodes(List<Integer> statusCodes)

  Match any HTTP status code in the provided list

• getVersion

   final PactSpecVersion getVersion()