ContextQMD
Back to Whistle

resReplace

docs/en/docs/rules/resReplace.md

2.10.43.8 KB
Original Source

resReplace

Replaces the response body content using a method similar to JavaScript's String.replace() (only valid for requests with a response body, such as 200 and 500). Supports multiple text formats:

  • JSON (application/json)
  • XML (application/xml)
  • HTML (text/html)
  • Plain text (text/xxx)

Rule Syntax

txt
pattern resReplace://value [filters...]
ParametersDescriptionDetailed Documentation
patternExpression to match against the request URLMatch Pattern Documentation
valueReplacement configuration object, supported from the following sources:
• Directory/file path
• Remote URL
• Inline/embedded/Values contentOperation Instruction Documentation
filtersOptional filters, supporting matching: • Request URL/Method/Header/Content • Response Status Code/HeaderFilter Documentation

Configuration Example

Inline Mode

txt
www.example.com/path file://(00user-11test-22user-33test) resReplace://user=abc&/\d+/g=number

Request https://www.example.com/path/to, browser receives:

txt
numberabc-numbertest-numberabc-numbertest

Inline Mode

txt
``` resReplace.json
user: name
/\d+/g: num
```
# or (note the escape character)
``` resReplace.json
{
  'user': 'name',
  '/\\d+/g': 'num'
}
```
www.example.com/path file://(00user-11test-22user-33test) resReplace://{resReplace.json}

Request https://www.example.com/path/to Content received by the browser:

txt
numname-numtest-numname-numtest

Local/Remote Resources

txt
www.example.com/path1 resReplace:///User/xxx/test.json
www.example.com/path2 resReplace://https://www.xxx.com/xxx/params.json
# Editing a temporary file
www.example.com/path3 resReplace://temp/blank.json

Associated Protocols {#related}

  1. Inject content before the response content (Prepend To Body): resPrepend
  2. Inject HTML content before the response content (Prepend HTML To Body, response type must be text/html): htmlPrepend
  3. Inject CSS content before the response content (Prepend CSS To Body, response type must be text/html or text/css): cssPrepend
  4. Inject JS content before the response content (Prepend JS To Body, response type must be text/html, text/css, or application/javascript): jsPrepend
  5. Replace the response content (Replace Body): resBody
  6. Replace the response content with HTML content (Replace Body, response type must be text/html): htmlBody
  7. Replace the response content with CSS content (Replace Body, response type must be text/html or text/css): cssBody
  8. Replace the response content with JS content (Replace Body, response type must be text/html, text/css, or application/javascript): jsBody
  9. Append content after the response content (Append To Body): resAppend
  10. Append HTML content after the response content (Append HTML To Body, response type must be text/html): htmlAppend
  11. Append CSS content after the response content (Append CSS To Body, response type must be text/html or text/css): cssAppend
  12. Append JS content after the response content (Append JS To Body, response type must be text/html, text/css, or application/javascript): jsAppend
  13. Replace the response content using keywords or regular expressions (Modify Body Text): resReplace
  14. Override JSON/Form objects in the response content (Modify Form/JSON): resMerge
  15. Delete a property from a JSON/Form object in the response content (Delete Form/JSON): delete://resBody.xxx