Using JS Libraries

Apidog's scripting engine supports both built-in libraries (available immediately) and external libraries (dynamically loaded via npm).

Built-in Libraries

You can require these libraries directly in your scripts without any setup.

Encode and Decode

Library	Version	Description
atob	v2.1.2	Base64 decode.
btoa	v1.2.1	Base64 encode.
crypto-js	v3.1.9-1	An Encoding / decoding library, including the common encoding and decoding methods (Base64, MD5, SHA, HMAC, AES, etc.). You can only require the entire module, not a submodule of the class library. View the documentation here for more details.
jsrsasign	10.3.0	RSA encryption / decryption. Only Apidog version 1.4.5 or later is supported.

Assertion

Library	Version	Description
chai	v4.2.0	BDD / TDD assertion library.

Tools

Library	Version	Description
postman-collection	v3.4.0	Postman Collection library.
cheerio	v0.22.0	A subset of jQuery.
lodash	v4.17.11	JS Utilities Library.
moment	v2.22.2	Date libraries (not including locales).
uuid	-	Generate UUID.
xml2js	v0.4.19	Convert XML into JSON.
csv-parse/lib/sync	v1.2.4	Parse CSV.

JSONSchema Validators

Library	Version	Description
tv4	v1.3.0	JSONSchema validator.
ajv	v6.6.2	JSONSchema validator.

Built-in NodeJS Modules

Library	Version	Description
path	-	Path module for handling file paths.
assert	-	Assertion testing module.
buffer	-	Buffer module for binary data.
util	-	Utility functions module.
url	-	URL parsing and resolution module.
punycode	-	Punycode encoding module.
querystring	-	Query string parsing module.
string-decoder	-	String decoder module.
stream	-	Stream module for streaming data.
timers	-	Timer functions module.
events	-	Event emitter module.

Usage Examples

SHA256 Encryption

HMAC-SHA256 Encryption

Base64 Encoding

Base64 Decoding

String Decoding:

JSON Decoding:

You can set the decoded JSON data as the response body using the pm.response.setBody() method.

AES Encryption

AES Decryption

Assuming an AES encrypted ciphertext with ECB mode and Pkcs7 padding, the AES decryption script example is as follows:

RSA Encryption

RSA Decryption

Below is a complete example of simple RSA encryption and decryption (Note: The jsrsasign version is 10.3.0; syntax may not be compatible with other versions). This example can be run in a Node.js environment and adapted for encryption or decryption operations in Apidog:

TIP

When using a built-in library, you can only require the entire module; submodules cannot be required individually.

// A correct example.
var cryptoJs = require("crypto-js");
console.log(cryptoJs.SHA256("Message"));

// A wrong example.
var SHA256 = require("crypto-js/sha256");
console.log(SHA256("Message"));

External Libraries (npm)

You can load any pure JavaScript library from npm using $$.liveRequire.

NOTE

This requires an active internet connection to download the package.

Single Library:

Multiple Libraries:

Built-in Libraries#

Encode and Decode#

Assertion#

Tools#

JSONSchema Validators#

Built-in NodeJS Modules#

Usage Examples#

SHA256 Encryption#

HMAC-SHA256 Encryption#

Base64 Encoding#

Base64 Decoding#

AES Encryption#

AES Decryption#

RSA Encryption#

RSA Decryption#

External Libraries (npm)#