GraphQL

1. Debug GraphQL requests

GraphQL uses the same URL to query different responses from the server, current debugging tools (e.g. Map Local, Breakpoint, Map Remote) doesn't work well.

However, by using the Scripting Tool, we can easily achieve:

  • Map Local for the response depends on QueryName

  • Manipulate the query, body, header for GraphQL Requests and Response

Map Local with the Scripting Tool

We can use the Scripting tool to map

  1. Open Proxyman

  2. Enable SSL Proxying on the GraphQL domain

  3. Verify that you can see HTTPS requests from your domain

  4. Right-Click on the flow -> Tool -> Scripting to create a script with the given URL

  5. To import a local file: Click the More button -> Import JSON or Other files -> Then selecting your file

  6. Use the following script shows you how to set a Local File to a GraphQL request with QueryName="user"

// Import file from More Button -> Import JSON or Other files
const file = require("@users/B02D96D5.default_message_32E64A5B.json");
function onRequest(context, url, request) {
// 1. Extract the queryName from the request
var queryName = request.body.query.match(/\S+/gi)[1].split('(').shift();
// 2. Save to sharedState
sharedState.queryName = queryName
// Done
return request;
}
function onResponse(context, url, request, response) {
// 3. Check if it's the request we need to map
if (sharedState.queryName == "user") {
// 4. Import the local file by Action Button -> Import
// Get the local JSON file and set it as a body (like Map Local)
response.headers["Content-Type"] = "application/json";
response.body = file;
}
// Done
return response;
}

Manipulate Headers, Query, Body

  1. Use the same code and change the queryName

  2. Please use the snipped code to change the values