Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 2.85 KB

mock-response-policy.md

File metadata and controls

59 lines (39 loc) · 2.85 KB
title description services author ms.service ms.topic ms.date ms.author
Azure API Management policy reference - mock-response | Microsoft Docs
Reference for the mock-response policy available for use in Azure API Management. Provides policy usage, settings, and examples.
api-management
dlepow
api-management
article
03/18/2024
danlep

Mock response

[!INCLUDE api-management-availability-all-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.

[!INCLUDE api-management-policy-generic-alert]

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'/>

Related policies

[!INCLUDE api-management-policy-ref-next-steps]