ContractTemplate (Spring Cloud Contract Spec 2.1.0.RC3 API)

```
public interface ContractTemplate
```
Contract for defining templated responses.
If no implementation is provided then Handlebars will be picked as a default implementation.

Since:

1.1.0

Author:

Marcin Grzejszczak

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`body()` Request body text (avoid for non-text bodies) e.g.
`String`	`body(String jsonPath)` Request body text for the given JsonPath.
`String`	`closingTemplate()` Handlebars is using the Mustache template thus it looks like this {{ Mustache }}.
`String`	`cookie(String key)` Retruns the template for retrieving the first value of a cookie with certain key
`default String`	`escapedBody()` Request body text (avoid for non-text bodies) e.g.
`default String`	`escapedBody(String jsonPath)` Request body text for the given JsonPath.
`default String`	`escapedClosingTemplate()` Handlebars is using the Mustache template thus it looks like this {{{ Mustache }}}.
`default String`	`escapedCookie(String key)` Retruns the template for retrieving the escaped first value of a cookie with certain key
`default String`	`escapedHeader(String key)` Returns the template for retrieving the escaped first value of a request header e.g.
`default String`	`escapedHeader(String key, int index)` Returns the template for retrieving the esacaped nth value of a request header (zero indexed) e.g.
`default String`	`escapedOpeningTemplate()` Handlebars is using the Mustache template thus it looks like this {{{ Mustache }}}.
`default String`	`escapedPath()` Returns the template for retrieving a escaped URL path
`default String`	`escapedPath(int index)` Returns the template for retrieving escaped nth value of a URL path (zero indexed) e.g.
`default String`	`escapedQuery(String key)` Returns the template for retrieving escaped first value of a query parameter e.g.
`default String`	`escapedQuery(String key, int index)` Returns the template for retrieving esacped nth value of a query parameter (zero indexed) e.g.
`default String`	`escapedUrl()` Returns the template for retrieving a escaped URL path and query from request
`String`	`header(String key)` Returns the template for retrieving the first value of a request header e.g.
`String`	`header(String key, int index)` Returns the template for retrieving the nth value of a request header (zero indexed) e.g.
`String`	`openingTemplate()` Handlebars is using the Mustache template thus it looks like this {{ Mustache }}.
`String`	`path()` Returns the template for retrieving a URL path
`String`	`path(int index)` Returns the template for retrieving nth value of a URL path (zero indexed) e.g.
`String`	`query(String key)` Returns the template for retrieving first value of a query parameter e.g.
`String`	`query(String key, int index)` Returns the template for retrieving nth value of a query parameter (zero indexed) e.g.
`default boolean`	`startsWithEscapedTemplate(String text)` Asserts whether the given text starts with proper opening template for escaped value
`default boolean`	`startsWithTemplate(String text)` Asserts whether the given text starts with proper opening template
`String`	`url()` Returns the template for retrieving a URL path and query from request

- Method Detail
  - startsWithTemplate
```
default boolean startsWithTemplate(String text)
```
    Asserts whether the given text starts with proper opening template
  - startsWithEscapedTemplate
```
default boolean startsWithEscapedTemplate(String text)
```
    Asserts whether the given text starts with proper opening template for escaped value
  - openingTemplate
```
String openingTemplate()
```
    Handlebars is using the Mustache template thus it looks like this {{ Mustache }}. In this case the opening template would return {{
  - closingTemplate
```
String closingTemplate()
```
    Handlebars is using the Mustache template thus it looks like this {{ Mustache }}. In this case the closing template would return }}
  - escapedOpeningTemplate
```
default String escapedOpeningTemplate()
```
    Handlebars is using the Mustache template thus it looks like this {{{ Mustache }}}. In this case the opening template would return {{{
  - escapedClosingTemplate
```
default String escapedClosingTemplate()
```
    Handlebars is using the Mustache template thus it looks like this {{{ Mustache }}}. In this case the closing template would return }}}
  - url
```
String url()
```
    Returns the template for retrieving a URL path and query from request
  - query
```
String query(String key)
```
    Returns the template for retrieving first value of a query parameter e.g. {{ request.query.search }}
    
    Parameters:
    
    key -
  - query
```
String query(String key,
             int index)
```
    Returns the template for retrieving nth value of a query parameter (zero indexed) e.g. {{ request.query.search.[5] }}
    
    Parameters:
    
    key -
    
    index -
  - path
```
String path()
```
    Returns the template for retrieving a URL path
  - path
```
String path(int index)
```
    Returns the template for retrieving nth value of a URL path (zero indexed) e.g. {{ request.path.[2] }}
    
    Parameters:
    
    index -
  - header
```
String header(String key)
```
    Returns the template for retrieving the first value of a request header e.g. {{ request.headers.X-Request-Id }}
    
    Parameters:
    
    key -
  - header
```
String header(String key,
              int index)
```
    Returns the template for retrieving the nth value of a request header (zero indexed) e.g. {{ request.headers.X-Request-Id.[5] }}
    
    Parameters:
    
    key -
    
    index -
  - cookie
```
String cookie(String key)
```
    Retruns the template for retrieving the first value of a cookie with certain key
    
    Parameters:
    
    key -
  - body
```
String body()
```
    Request body text (avoid for non-text bodies) e.g. {{ request.body }} . The body will not be escaped so you won't be able to directly embed it in a JSON for example.
  - body
```
String body(String jsonPath)
```
    Request body text for the given JsonPath. e.g. {{ jsonPath request.body '$.a.b.c' }}
  - escapedUrl
```
default String escapedUrl()
```
    Returns the template for retrieving a escaped URL path and query from request
  - escapedQuery
```
default String escapedQuery(String key)
```
    Returns the template for retrieving escaped first value of a query parameter e.g. {{{ request.query.search }}}
    
    Parameters:
    
    key -
  - escapedQuery
```
default String escapedQuery(String key,
                            int index)
```
    Returns the template for retrieving esacped nth value of a query parameter (zero indexed) e.g. {{{ request.query.search.[5] }}}
    
    Parameters:
    
    key -
    
    index -
  - escapedPath
```
default String escapedPath()
```
    Returns the template for retrieving a escaped URL path
  - escapedPath
```
default String escapedPath(int index)
```
    Returns the template for retrieving escaped nth value of a URL path (zero indexed) e.g. {{{ request.path.[2] }}}
    
    Parameters:
    
    index -
  - escapedHeader
```
default String escapedHeader(String key)
```
    Returns the template for retrieving the escaped first value of a request header e.g. {{{ request.headers.X-Request-Id }}}
    
    Parameters:
    
    key -
  - escapedHeader
```
default String escapedHeader(String key,
                             int index)
```
    Returns the template for retrieving the esacaped nth value of a request header (zero indexed) e.g. {{{ request.headers.X-Request-Id.[5] }}}
    
    Parameters:
    
    key -
    
    index -
  - escapedCookie
```
default String escapedCookie(String key)
```
    Retruns the template for retrieving the escaped first value of a cookie with certain key
    
    Parameters:
    
    key -
  - escapedBody
```
default String escapedBody()
```
    Request body text (avoid for non-text bodies) e.g. {{{ request.body }}} . The body will not be escaped so you won't be able to directly embed it in a JSON for example.
  - escapedBody
```
default String escapedBody(String jsonPath)
```
    Request body text for the given JsonPath. e.g. {{{ jsonPath request.body '$.a.b.c' }}}

Interface ContractTemplate

Method Summary

Method Detail

startsWithTemplate

startsWithEscapedTemplate

openingTemplate

closingTemplate

escapedOpeningTemplate

escapedClosingTemplate

url

query

query

path

path

header

header

cookie

body

body

escapedUrl

escapedQuery

escapedQuery

escapedPath

escapedPath

escapedHeader

escapedHeader

escapedCookie

escapedBody

escapedBody