The following guide will show you how to write JS code to change the Request domain from Production to Localhost and change the Response Body
1.
Make sure you enable SSL for this domain before creating the script)
2.
Open Scripting Tool and create a new Script Entry (⌘N). You can right-click on the Request -> Tools -> Scripting => Proxyman will create a Script too
3.
Give the name and define a Matching Rule.
4.
Ex: Name=Test on Localhost endpoint, URL=https://proxyman.io
5.
Enable Run Script on Request and Responsecheckbox
6.
Start writing JS code for onRequest function
onRequest(context, url, request) {}
1
// Import UUID addons
2
const{ uuidv4 }=require("@addons/UUID.js");
3
​
4
/// This func is called if the Request Checkbox is Enabled
5
/// You can manipulate the Request Data here before the request hits on the server
6
/// e.g. Add/Update/Remove: host, scheme, port, path, headers, queries, comment, color and body (json, form, plain-text, base64 encoded string)
7
///
8
/// Use console.log(request) to see all available fields
9
/// Action Menu -> Import File to import a JSON file and use in the script. Or Import directly with request.bodyFilePath = "~/Desktop/myfile.json" (Applied for Response too)
10
/// Use global object `sharedState` to share data between Requests/Response from different scripts (e.g. sharedState.data = "My-Data")
11
///
12
functiononRequest(context, url, request){
13
// print log
14
console.log(request);
15
​
16
// Change Production domain -> Localhost
17
request.method ="GET";
18
request.scheme ="http";
19
request.host ="localhost";
20
request.port =8000;
21
22
// Add new header
23
request.headers["X-New-Header"]="Hello From Scripting feature";
24
request.headers["UUID"]=uuidv4();// generate random UUIDv4
25
delete request.headers["Key-Need-Delete"];
26
​
27
// Update or Add a new Query
28
request.queries["name"]="Proxyman";
29
​
30
// Update Body
31
var body = request.body;
32
body["name"]="Proxyman";
33
request.body = body;
34
35
// Or Map the body with a local file (Proxyman 2.25.0+)
On certain occasions, you might encounter Javascript errors due to syntax errors, invalid code, ... You can debug by looking at error messages on the console or using console.log().
8. Use Scripting as a Mock API
From Proxyman 2.32.0, we can use Scripting Tool as a Mock API. It means your request would never hit the server, and you have to define a Response Body. This behavior is the same with Map Local.
This feature is useful when the actual Restful API is not available yet. You can define and test it locally.