
Security News
GitHub Actions Supply Chain Attack Puts Thousands of Projects at Risk
A compromised GitHub Action exposed secrets in CI/CD logs, putting thousands of projects at risk and forcing developers to urgently secure their workflows.
@springworks/api-client
Advanced tools
Module for sending requests to other APIs through a circuit breaker created by @springworks/circuit-breaker-factory.
createClient(params)
Creates a api client using the provided config. Returns an object that exposes a sendRequest(opts, expected_status_codes)
function that returns a Promise.
params
Name | Type | Description | Required |
---|---|---|---|
base_url | String | Fully qualified uri string used as the base url | Yes |
circuit_breaker_config | Object | The circuit breaker config. Please refer to this documentation for details. | Yes |
logger | Bunyan | Bunyan logger | Yes |
opt_options | Object | - | No |
opt_options.opt_auth | Object | Optional authentication object that will be used for all requests sent towards the provided base_url . If there is an auth property in the options send in sendRequest then opt_auth gets overwritten. | No |
opt_options.opt_timeout | Number | Timeout (millis) used in all request from created client. | No |
sendRequest(options, expected_status_codes)
Sends the request based on the provided options and returns a resolved/rejected Promise.
Options
Parameter | Description | Type | Required |
---|---|---|---|
endpoint_uri | URI of the endpoint that's to be reached | string | Yes |
The rest of the options match the options from the request HTTP client module and can be seen there.
expected_status_codes
Type | Description | Entries Type | Entries Range | Required |
---|---|---|---|---|
Array | Expected status codes by the invoker of this function | Number | [100, 500) | Yes |
Example Usage
var api_client_factory = require('@springworks/api-client');
var config = {
source_name: 'my-api',
target_name: 'facebook-graph-api',
window_duration: 1000,
num_buckets: 10,
timeout_duration: 3000,
error_threshold: 50,
volume_threshold: 5
};
var api_client = api_client_factory.createClient('http://api.machinetohuman.com', config, bunyan_logger);
var options = {
endpoint_uri: '/vehicles/1234',
// other request options
};
var expected_status_codes = [200];
api_client.sendRequest(options, expected_status_codes)
.then(function(response_body) {
// do your thing;
})
.catch(function(reason) {
// handle rejection error here;
});
FAQs
Module for sending requests to other APIs through a circuit breaker
The npm package @springworks/api-client receives a total of 143 weekly downloads. As such, @springworks/api-client popularity was classified as not popular.
We found that @springworks/api-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers 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.
Security News
A compromised GitHub Action exposed secrets in CI/CD logs, putting thousands of projects at risk and forcing developers to urgently secure their workflows.
Research
Security News
A malicious Maven package typosquatting a popular library is secretly stealing OAuth credentials on the 15th of each month, putting Java developers at risk.
Security News
Socket and Seal Security collaborate to fix a critical npm overrides bug, resolving a three-year security issue in the JavaScript ecosystem's most popular package manager.