Refer to CONTRIBUTING.md for information on how to contribute, committing changes, releases and snapshots.
This service uses Convict library for managing configuration. Using Convict, we can specify the configuration using json files and through the environment variable.
The precedence order is explained in this section.
You can have a look at the environment variables in the config folder.
Here are the options that can be configured through environment variables.
| Environment variable | Description | Example values | Default value |
|---|---|---|---|
| PORT | The port of the API server | 0 to 65535 | 8000 |
| MOCK_SERVICE_HOST | The Hostname/IP address of mock service | mock-service-host | |
| MOCK_SERVICE_PORT | The port of mock service | 0 to 65535 | 3001 |
| GET_DATA_FROM_MOCK_SERVICE | Whether to connect to mock service and get the sample data | true,false | false |
ModusBox libraries are officially hosted on Github: https://github.com/orgs/modusbox/packages
To correctly resolve @modusbox/* specific libraries, one needs to add the below entry in an .npmrc file in your NodeJS's project root folder.
@modusbox:registry=https://npm.pkg.github.com
This will allow npm install to correctly fetch dependencies from ModusBox's NPM registry hosted on GitHub.
If the .npmrc is not configured as such, the @modusbox/* dependencies will be pulled from the standard NPM registries.
Command to install dependencies:
npm installCommand to transpile Typescript into JS:
npm run buildCommand to LIVE transpile Typescript into JS live when any changes are made to the code-base:
npm run watchnpm startnpm testPlease refer this documentation to learn more about functional tests.
An example API server is implemented using express library.
Swagger (OpenAPI) validation is added to the express middleware. All the requests will be validated against the API specification in the swagger file. This is to support API first development approach.
The URL for the swagger UI is http://localhost:8000/docs