Modify Response Body

Modify Response Body

Popular use cases

• You want to work on front-end while back-end is not available or ready yet.

• You want to test application behaviour when provided altered data.

• You want to simulate errors by returning different status codes.

• You want to modify API responses but don't have access to the back-end.

Supported resource types

• Rest API: Supports modifying XHR/fetch requests.

• GraphQL API: Target & modify GraphQL api using operation.

• HTML/JS/CSS: Only available in Desktop app

Types of Modifications

Static Response Modification

1. Source Condition : If the request url matches this source condition, then only the rule is applied. You can use URL, Host or Path with Regex, Contains, Wildcard or Equals to match the source request. Learn more about source conditions here.

2. Status Code : Update the Response status code. (2XX, 3XX, 4XX, 5XX ...). If left empty, original status code is returned.

3. Static Response Body : Define the updated response body which needs to be returned.

4. Source Filters : This helps you define better targeting conditions and restrict rules to be applied on specific webpages (or domains), request types, request methods, or request payload. Learn more about source filters here.

Programmatic Response Modification

Arguments of modifyResponse

1. method (string)- The HTTP method of the request. GET | POST | PUT | DELETE etc.

2. url (string) - The request URL.

3. response (string)- The original response object represented as string. Eg:

'{"id":1,"app":"requestly","feature":"modify-request"}'

1. responseType (string)- The content-type of the HTTP response.

2. requestHeaders (Object<string, string>)- The request headers sent to the server.

3. requestData (string)- The HTTP request payload in case of POST | PUT | PATCH requests.

4. responseJSON (JSON object)- The original response represented as JSON Object:

{
  "id":1,
  "app":"requestly",
  "feature":"modify-request"
}

Return type of modifyResponse (string or JSON object)

Targeting GraphQL requests

• Payload JSON Key, e.g., operationName

• Value, e.g., getUsers

Guides

• Modifying Response asynchronously: Async modifications lets you perform some long running tasks before returning the response

• Modifying Non Existent Domain: Helpful for frontend developers when the backend isn't ready yet.

FAQs