Scripting
Proxyman offers a scripting feature that the developer could write the JS code to manipulate the Request/Response in a flexible way.
Implement Map Local / Map Remote / Breakpoint by JS Code. 100x Faster
Change the Request Content, includes Domain, Host, Scheme, Port, Path, HTTP Method, HTTP Headers, Query, Body (Encoded-Form, JSON, plain-text)
Change the Response Content, includes HTTP Status Code, HTTP Headers, Body (JSON, Encoded-Form, plain-text, binary...)
Provide plenty of built-in addons and libraries for common tasks, such as Hashing, Encode/Decode, JSON-Text transformer, Beautify,...
Able to write your own JS Addons or Libraries
Designed to replace Rewrite GUI Tool
Assign and receive shared States between each script or current session with ShareState or Environment Variables
You can access the Scripting Tool by:
Script Menu -> Script List (⌥⌘I)
Open Menu Context from Right Click on the Flow -> Tools -> Scripting
Checkout Snippet Code to see a collection of snippet JS code for the Scripting Tool.
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
Make sure you enable SSL for this domain before creating the script)
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
Give the name and define a Matching Rule.
Ex: Name=Test on Localhost endpoint, URL=https://proxyman.io
Enable Run Script on Request and Response checkbox
Start writing JS code for
onRequestfunction
onRequest(context, url, request) {}
// Import UUID addonsconst { uuidv4 } = require("@addons/UUID.js");////// This func is called if the Request Checkbox is Enabled/// You can manipulate the Request Data here before the request hits on the server/// Ex: Add/Update/Remove HTTP Header, Query, Form, Body, Host, Port, Path/// Use console.log(request) to see all available fields///function onRequest(context, url, request) {// print logconsole.log(request);// Change Production domain -> Localhostrequest.method = "GET";request.scheme = "http";request.host = "localhost";request.port = 8000;// Add new headerrequest.headers["X-New-Header"] = "Hello From Scripting feature";request.headers["UUID"] = uuidv4(); // generate random UUIDv4delete request.headers["Key-Need-Delete"];// Update or Add a new Queryrequest.queries["name"] = "Proxyman";// Donereturn request;}
context, url and request objects are defined by:
// context (readonly){"scriptName": "<String> Your Script Name","matchingRule": "<String> Your Matching Rule","matchingMethod": "<String> Method","isEnableOnRequest": "Bool","isEnableOnResponse": "Bool","filePath": "<String> Script path","flow": { // Availble from 2.16.0+"serverPort": "443","serverIpAddress": "104.18.230.83","clientIpAddress": "192.168.0.102","remoteDeviceName": "iPhone XR","remoteDeviceIP": "192.168.0.102","id": "51","clientPath": null,"clientPort": "51494","clientName": null},}// url (readonly)url: String // => Present the full URL// request{"method": "<String> HTTP Method. Accept string method. Ex: GET, POST, ...","scheme": "<String> Accept http or https","host": "<String> Host of the request. Ex: api.proxyman.io, localhost, ...","path": "<String>: Path of the URL. Ex: /v1/data","port": "<Int> Accept int port number. Ex: 443, 8080, ..","queries": "<[String: Any]> A JS Object (Dictionary) contains key values of the query","headers": "<[String: Any]> A JS Object (Dictionary) contains key values of the header","body": "Depend on the Content-Type header. It might be a dictionary for JSON and form, Plain Text or Base64 Encoded String","rawBody": "<Readonly>: A raw body String or Base64 encoded string if it's a binary","preserveHostHeader": "<Bool> Preserve the Host"}
You can change any value of the request obj except rawBody
If the body variable is invalid format due to incorrect Content-Type in the Header. Please consider using the rawBody and manually parse the string.
The type of request.body replies on the Content-Type Header.
Content-Type Header | request.body |
application/json or JSON families | Javascript Object |
application/x-www-form-urlencoded | Javascript Object |
plain-text or text-based Content-Type, Ex: application/js, text/css, text/html, ... | String |
The rest (application/zip, application/octet-stream) | Base64 Encoded String |
Check out common JS code from Snipped Code Page
7. Start writing code on onResponse function
////// This func is called if the Response Checkbox is Enabled/// You can manipulate the Response Data here before it goes to the client/// Ex: Add/Update/Remove HTTP Header, Status, Body,.../// Use console.log(response) to see all available fields///function onResponse(context, url, request, response) {console.log(response);// Update or Add a new headerresponse.headers["Content-Type"] = "application/json";// Update status Coderesponse.statusCode = 500;// Update Bodyvar body = response.body;body["new-key"] = "Proxyman";response.body = body;// Donereturn response;}
context, url, request, and response objects are defined by:
// context (readonly): Same with onRequest// url (readonly): Same with onRequest// request (readonly): Same with onRequest// response{"statusCode": "<Int> Status Code. Ex: 200, 400, 404,...","httpVersion": "<String><Readonly> The HTTP Version","statusPhrase": "<String><Readonly> HTTP Status Phrase. Ex Not Found, OK, ...","headers": "<[String: Any]> A JS Object (Dictionary) contains key values of the header","body": "Depend on the Content-Type header. It might be a dictionary for JSON and form, PlainText or Base64 Encoded String","rawBody": "<Readonly>: A raw body String or Base64 encoded string if it's a binary"}
You can change statusCode, headers and body from the response Obj
If the body variable is invalid format due to incorrect Content-Type in the Header. Please consider using rawBody and manually parse the string.
The type of response.body replies on the Content-Type Header
Content-Type Header | request.body |
application/json or JSON families | Javascript Object |
application/x-www-form-urlencoded | Javascript Object |
plain-text or text-based Content-Type, Ex: application/js, text/css, text/html, ... | String |
The rest (application/zip, application/octet-stream) | Base64 Encoded String |
You must return request and response object in onRequest and onResponse function
Proxyman provides plenty of addons and libraries that help you achieve common tasks: Hashing, Encode/Decode, ...
On certain occasions, you might encounter Javascript error due to syntax error, invalid code, ... You can debug by looking at error message on the console or using console.log()
You must return
requestandresponseObject inonRequestandonResponsefunctionSince Javascript doesn't have the Data object type, the Data Body will convert to Base64 Encoded String in Javascript
To pass Uint8Array, blob, or ArrayBuffer to the body, make sure you convert to Base64 Encoded String
// Your binary, Uint8Array, blob data,...var myData = fromFile();// Importconst { btoa } = require('@addons/Base64.js');// Convert to base64 encoded stringresponse.body = btoa(myData);
