Mock API Response Policy

Returns example responses from the OpenAPI document associated with this route.

Configuration

{
  "name": "my-mock-api-inbound-policy",
  "policyType": "mock-api-inbound",
  "handler": {
    "export": "MockApiInboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {}
  }
}

name the name of your policy instance. This is used as a reference in your routes.
policyType the identifier of the policy. This is used by the Zuplo UI. Value should be mock-api-inbound.
handler/export The name of the exported type. Value should be MockApiInboundPolicy.
handler/module the module containing the policy. Value should be $import(@zuplo/runtime).
handler/options The options for this policy:
- random
  Optional. Indicates whether the response should be selected randomly, from the available examples (that match any filter criteria). If false the first matching example is used.
- responsePrefixFilter
  Optional. Specifies a prefix to match the responses to select from. Typically this is a status code like "200" or "2XX". If you want the policy to select randomly from all 2XX codes, set this property to "2" and random to true.
- contentType
  Optional. Specify the content-type of the response to select from. If not specified, the first matching response is used (or random).
- exampleName
  Optional. Specify the name of the example to select. If not specified, the first matching response is used (or random).

Configuration​

Configuration