APITestRunner

APITesting. APITestRunner

APITestRunner

Constructor

new APITestRunner()

A class for creating an APITestRunner.

Methods

run(testPath, inParams[opt], profileName[opt]) → {Promise.<Object>}

Runs the API test.
Parameters:
NameTypeAttributesDescription
testPathstringThe folder path of API test.
inParamsObject <optional>
The list of input parameters to run the API test.
profileNamestring <optional>
The active profile.
Returns:
a promise that is fulfilled with the results of the API test that ran.
The returned object contains two keys:
status - the result of the API test: true = passed; false = failed
outParams - the list of returned output parameters from the API test with the key and value
Type
Promise.<Object>