GraphQL

1. Use Debugging Tools with GraphQL Requests (2.27.0+)
From Proxyman 2.27.0, we can use debugging tools with GraphQL Requests by specifying the GraphQL Query Name.
Matching by GraphQL QueryName works with Breakpoint, Map Local, Map Remote, Block List, Allow List, and the Scripting Tool.
How to use
1.Open the debugging tool (e.g. Breakpoint)
2.Create new Rule
3.Click on Use "Wildcard Dropdown" -> Advanced -> Check GraphQL QueryName.
4.Enter the GraphQL QueryName
By doing this way, the debugging tool will match the original matching rule firstly, then matching the GraphQL QueryName.
Enable GraphQL QueryName
Specify the GraphQL QueryName
2. GraphQL Prettier
From Proxyman 2.33.0, Proxyman can prettify/beautify GraphQL's Query Value. To do it, please open Tools Menu -> Custom Previewer Tab -> Check GraphQL checkbox.
Beautify GraphQL Query
3. Show GraphQL Query Name on the main table view
It's possible to extract and display the Query Name. Please Right-click on the Column Header and enable it.
Query Name from GrapQL Request
Custom Header Column
4. Debug GraphQL Requests (Legacy - Proxyman 2.26.0 and below)
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"
1
// Import file from More Button -> Import JSON or Other files 
2
const file = require("@users/B02D96D5.default_message_32E64A5B.json");
3
​
4
function onRequest(context, url, request) {
5
​
6
  // 1. Extract the queryName from the request
7
  var queryName = request.body.query.match(/\S+/gi)[1].split('(').shift();
8
  
9
  // Or extract the operationName
10
  var operationName = request.body.operationName
11
  
12
  // 2. Save to sharedState
13
  sharedState.queryName = queryName
14
  sharedState.operationName = operationName
15
  
16
  // Done
17
  return request;
18
}
19
​
20
function onResponse(context, url, request, response) {
21
​
22
  // 3. Check if it's the request we need to map
23
  if (sharedState.queryName == "user") {
24
    
25
    // 4. Import the local file by Action Button -> Import
26
    // Get the local JSON file and set it as a body (like Map Local)
27
    response.headers["Content-Type"] = "application/json";
28
    response.body = file;
29
  }
30
​
31
  // Done
32
  return response;
33
}
Copied!
Manipulate Headers, Query, Body
1.Use the same code and change the queryName 
2.Please use the snipped code to change the values

ADVANCED FEATURES - Previous

Custom Certificates

Next - ADVANCED FEATURES

Network Conditions

Last modified 2mo ago

Copy link

Contents

1. Use Debugging Tools with GraphQL Requests (2.27.0+)

2. GraphQL Prettier

3. Show GraphQL Query Name on the main table view

4. Debug GraphQL Requests (Legacy - Proxyman 2.26.0 and below)

Map Local with the Scripting Tool

Manipulate Headers, Query, Body