<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@contract-case/case-definition-dsl](./case-definition-dsl.md) &gt; [matchers](./case-definition-dsl.matchers.md) &gt; [http](./case-definition-dsl.matchers.http.md) &gt; [HttpResponseExample](./case-definition-dsl.matchers.http.httpresponseexample.md)

## matchers.http.HttpResponseExample interface

**Signature:**

```typescript
export interface HttpResponseExample
```

## Properties

<table><thead><tr><th>

Property

</th><th>

Modifiers

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

[body?](./case-definition-dsl.matchers.http.httpresponseexample.body.md)

</td><td>

`readonly`

</td><td>

AnyMatcherOrData

</td><td>

_(Optional)_ A test equivalence matcher or json object that describes the body for this response. If not provided, no body matching is performed.

</td></tr>
<tr><td>

[headers?](./case-definition-dsl.matchers.http.httpresponseexample.headers.md)

</td><td>

`readonly`

</td><td>

AnyMatcherOrData

</td><td>

_(Optional)_ A Map of header names and associated test-equivalence matcher values accepted by this example. If not provided, no header matching is performed

</td></tr>
<tr><td>

[status](./case-definition-dsl.matchers.http.httpresponseexample.status.md)

</td><td>

`readonly`

</td><td>

AnyMatcherOrData

</td><td>

Any test-equivalence matcher, string, or number for the HTTP status code accepted by this example (Recommended: Use the `HttpStatusCode` matcher)

</td></tr>
<tr><td>

[uniqueName?](./case-definition-dsl.matchers.http.httpresponseexample.uniquename.md)

</td><td>

`readonly`

</td><td>

string

</td><td>

_(Optional)_ What unique name, if any, to give to this response

</td></tr>
</tbody></table>
