
Product
Introducing License Overlays: Smarter License Management for Real-World Code
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
Apiunit is an awesome api unit testing framework! It allows creation of http requests and responses to create unit tests.
--input (-i): path to directory containing inputs (/requests is default) --diff (-d): path to directory containing expected output (/responses is default) --parameter (-p): path to the parameter .json file --prefix (-x): prefix of request(input) files to run --cmd (-c): command to be run between scenarios --scn (-s): The scenario or comma separated scenarios to run.
Parameter files should be JSON format. Here is an example:
{ "PARAM1":"VALUE1", "PARAM2":"VALUE2", "settings":{ "scenarios":{ "scn1":{ "PARAM1":"scn1", "PARAM2":"scn1" }, "scn2":{ "PARAM1":"scn2", "PARAM2":"scn2" } }, "groups":{ "assets/testSuite":[ "scn1", "scn2" ] } } }
In this example we are running two scenarios named scn1 and scn2 on the folder(group) of "assets/testSuite". In each scenario, the PARAM1 and PARAM2 variables will be replaced with the values in the scenarios.
Request files should end with .req or .msg extension, and response files should end with .resp extension. Every request should have a matching response with the same name minus extension. Response files can also use regular expressions to match expected responses.
Request files also allow the parameter APIUNIT-RETRY which can be set to any value, but default is 15000ms. APIUNIT-RETRY will retry the request until it matches the associated response or fails within the given timeframe.
Example request:
GET ${some-domain-name-from-parameters}/some-path/${some-id-from-previous-test-or-parameters}
Example response:
200 content-type: application/json { "maybe-an-id":".+", "some-field":"some-value", "another-field":"another-value" }
To run a simple apiunit task just run the command "node ../node_modules/.bin/apiunit -i specs/requests -d specs/responses -p parameters.json -c "npm run add-some-data-or-something"".
FAQs
Unit testing framework for API
The npm package apiunit receives a total of 916 weekly downloads. As such, apiunit popularity was classified as not popular.
We found that apiunit demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
Product
Socket now supports Rust and Cargo, offering package search for all users and experimental SBOM generation for enterprise projects.
Product
Socket’s precomputed reachability slashes false positives by flagging up to 80% of vulnerabilities as irrelevant, with no setup and instant results.