Skip to main content
Unlike REST APIs, GraphQL APIs provide a flexible approach to querying and mutating data through a single endpoint. They allow clients to specify exactly what data is needed, reducing over-fetching and under-fetching issues common with REST APIs. GraphQL APIs can be modified to customize requests and responses for testing and debugging. This guide provides detailed steps to achieve this using Requestly Interceptor.
To modify the response of a GraphQL API:
For additional details, visit the Modify API Response Rule Page.
Notes
Example Without
In cases where the operation is specified within the
You can modify the response using a JavaScript snippet:
For additional details, visit the Modify Request Rule Page.
Advanced Traffic Rules
GraphQL Support
Learn to modify GraphQL API requests and responses using Requestly Interceptor to debug and test GraphQL APIs.
Unlike REST APIs, GraphQL APIs provide a flexible approach to querying and mutating data through a single endpoint. They allow clients to specify exactly what data is needed, reducing over-fetching and under-fetching issues common with REST APIs. GraphQL APIs can be modified to customize requests and responses for testing and debugging. This guide provides detailed steps to achieve this using Requestly Interceptor.
Modifying GraphQL Responses
In GraphQL, client interactions are typically managed through a single HTTP endpoint. The specific operation to execute is often indicated by theoperationName field in the request payload.
Example Request
Steps to Modify API Response
1
Open HTTP Rules
Navigate to the HTTP Rules section in the web or desktop app.
2
Create a New Rule
Click on ”+ New Rule” and select Modify API Response.
3
Configure Resource Type
Choose “GraphQL API” as the Resource Type.
4
Set GraphQL Operation Filter
In the GraphQL Operation (Request Payload Filter) section:
-
Enter Key as
operationName. -
Enter Value as the operation name you want to target (e.g.,
getUsers).
5
Customize Response
Define the new response you want to serve for the specified operation.
6
Save and Activate
Click Save to store the rule and toggle it ON to apply the changes.
7
Test the Rule
Validate the rule by sending a request matching your conditions and verifying the modified response.
-
The Key represents the JSON key in the request payload and supports nested paths. For example:
-
If
operationNameis located atdata.operationName, specifydata.operationName. -
For array payloads, such as
[{"operationName": "value"}], use0.operationNameas the key.
-
If
-
If the request does not include
operationName, select Resource Type as “REST API” and use Dynamic (JavaScript) Mode to filter and modify the response.
Example Without operationName
In cases where the operation is specified within the query field:
Modifying GraphQL Requests
If you need to alter the GraphQL query or its variables, use the Modify Request Body rule to change the request payload dynamically.Steps to Modify Request Body
1
Open HTTP Rules
Navigate to the HTTP Rules tab in the web or desktop app.
2
Create a New Rule
Click on ”+ New Rule” and select Modify Request Body.
3
Configure Resource Type
Choose “GraphQL API” as the Resource Type.
4
Set GraphQL Operation Filter
In the GraphQL Operation (Request Payload Filter) section:
-
Enter Key as
operationName. -
Enter Value as the operation name you want to target (e.g.,
getUsers).
5
Customize Request
Define the new Request you want to serve for the specified operation
6
Save and Activate
Click Save to store the rule and toggle it ON to apply the changes
7
Test the Rule
Validate the rule by sending a request matching your conditions and verifying the modified response.