Replace String in Response Body Policy

Replace a string in the incoming request body

Configuration

The configuration shows how to configure the policy in the 'policies.json' document.

{
  "name": "my-replace-string-outbound-policy",
  "policyType": "replace-string-outbound",
  "handler": {
    "export": "ReplaceStringOutboundPolicy",
    "module": "$import(@zuplo/runtime)",
    "options": {
      "match": "/(\\d+)/g",
      "mode": "regexp",
      "replaceWith": "1234"
    }
  }
}

Policy Configuration

  • name <string> - The name of your policy instance. This is used as a reference in your routes.
  • policyType <string> - The identifier of the policy. This is used by the Zuplo UI. Value should be replace-string-outbound.
  • handler.export <string> - The name of the exported type. Value should be ReplaceStringOutboundPolicy.
  • handler.module <string> - The module containing the policy. Value should be $import(@zuplo/runtime).
  • handler.options <object> - The options for this policy. See Policy Options below.

Policy Options

The options for this policy are specified below. All properties are optional unless specifically marked as required.

  • mode <string> (Required) -
    The type of string replacement to perform.
    Allowed values are regexp, and string.
  • match <string> (Required) -
    The pattern to match.
  • replaceWith <string> (Required) -
    The value to each match is replaced with.

Using the Policy

Read more about how policies work