browserup-mitmproxy-client
BrowserUpMitmProxyClient - JavaScript client for browserup-mitmproxy-client
This is the REST API for controlling the BrowserUp MitmProxy. The BrowserUp MitmProxy is a swiss army knife for automated testing that captures HTTP traffic in HAR files. It is also useful for Selenium/Cypress tests.
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
Node.js
Fornpm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install browserup-mitmproxy-client --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your browserup-mitmproxy-client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var BrowserUpMitmProxyClient = require('browserup-mitmproxy-client');
var api = new BrowserUpMitmProxyClient.BrowserUpProxyApi()
var counter = new BrowserUpMitmProxyClient.Counter(); // {Counter} Receives a new counter to add. The counter is stored, under the hood, in an array in the har under the _counters key
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.addCounter(counter, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8088
Class | Method | HTTP request | Description |
---|---|---|---|
BrowserUpMitmProxyClient.BrowserUpProxyApi | addCounter | POST /har/counters | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | addError | POST /har/errors | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | getHarLog | GET /har | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | healthcheck | GET /healthcheck | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | newPage | POST /har/page | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | resetHarLog | PUT /har | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | verifyNotPresent | POST /verify/not_present/{name} | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | verifyPresent | POST /verify/present/{name} | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | verifySLA | POST /verify/sla/{time}/{name} | |
BrowserUpMitmProxyClient.BrowserUpProxyApi | verifySize | POST /verify/size/{size}/{name} |
Documentation for Models
- BrowserUpMitmProxyClient.Counter
- BrowserUpMitmProxyClient.Entry
- BrowserUpMitmProxyClient.EntryRequest
- BrowserUpMitmProxyClient.EntryRequestCookies
- BrowserUpMitmProxyClient.EntryRequestQueryString
- BrowserUpMitmProxyClient.EntryResponse
- BrowserUpMitmProxyClient.EntryResponseContent
- BrowserUpMitmProxyClient.EntryTimings
- BrowserUpMitmProxyClient.Error
- BrowserUpMitmProxyClient.Har
- BrowserUpMitmProxyClient.HarLog
- BrowserUpMitmProxyClient.HarLogCreator
- BrowserUpMitmProxyClient.Header
- BrowserUpMitmProxyClient.MatchCriteria
- BrowserUpMitmProxyClient.NameValuePair
- BrowserUpMitmProxyClient.Page
- BrowserUpMitmProxyClient.PagePageTimings
- BrowserUpMitmProxyClient.VerifyResult
- BrowserUpMitmProxyClient.WebSocketMessage
Documentation for Authorization
All endpoints do not require authorization.