@bcc-code/bcc-core-api-node-sdk
v1.18.1
Published
NodeJS client for bcc-code/bcc-core-api-node-sdk
Downloads
238
Keywords
Readme
BCC Core API Node SDK
This project's goal is to allow other applications to integrate with BCC's core data in an easy and reliable way. This SDK is meant for NodeJS applications and is downloadable through NPM.
Testing
To run the tests:
- Start the Core API emulator (run script at
scripts/sdk-setup-test-environment.sh
or run VS Code tasksdk-setup-test-environment
) - Install npm dependencies
npm install
- Run the tests
npm run test
Notes
The current SDK is only meant to be used for the following entities:
- Countries
- Orgs
- Persons
- Relations
- Affiliations
- Consents
- Roles
- Role Assignments
There is also an Auth module to allow for easy authentication with the oauth2 client credentials flow.
Code generation
As mentioned above, a part of this client is generated by the OpenAPI Generator. This is done through the script in the repository root at ./scripts/generate-sdks.sh
.