Mock response

  • Article

APPLIES TO: All API Management tiers

The mock-response policy, as the name implies, is used to mock APIs and operations. It cancels normal pipeline execution and returns a mocked response to the caller. The policy always tries to return responses of highest fidelity. It prefers response content examples, when available. It generates sample responses from schemas, when schemas are provided and examples aren't. If neither examples or schemas are found, responses with no content are returned.

Note

Set a policy's elements and child elements in the order provided in the policy statement. Learn more about how to set or edit API Management policies.

Policy statement

<mock-response status-code="code" content-type="media type"/>

Attributes

Attribute Description Required Default
status-code Specifies response status code and is used to select corresponding example or schema. Policy expressions aren't allowed. No 200
content-type Specifies Content-Type response header value and is used to select corresponding example or schema. Policy expressions aren't allowed. No None

Usage

Usage notes

Examples

<!-- Returns 200 OK status code. Content is based on an example or schema, if provided for this status code. First found content type is used. If no example or schema is found, the content is empty. -->
<mock-response/>

<!-- Returns 200 OK status code. Content is based on an example or schema, if provided for this status code and media type. If no example or schema found, the content is empty. -->
<mock-response status-code='200' content-type='application/json'/>

Next steps

For more information about working with policies, see: