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
  [object Object]
- responsePrefixFilter
  [object Object]
- contentType
  [object Object]
- exampleName
  [object Object]

Configuration​

Configuration