Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.76 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.76 KB
Raw

cc-api-sandbox

cc-api-sandbox is a mock server for the Console Connect API.

Please, be aware that this repo is under heavy development, and should be expected to change rapidly.

Installation

Use Docker Compose to build and run the container

docker compose up --build

Usage

Simply open your favorite CLI or browser and navigate to http://127.0.0.1:9000

Contributing

Pull requests are welcome and encouraged!

For details, please see CONTRIBUTING.md.

Updating the OpenAPI Specification

There is a modified version of the Console Connect OpenAPI specification included in the repository. To update the spec, simply remove the old specification from the specs/ folder and push a new version with the filename ccapi_YYYYMMDD.json, where YYYY is the 4 digit year, MM is the two digit month, and DD is the two digit day. Then update the filename in src/app.ts to match.

To try out a new specification file locally, you can pass in the path to the file through the environment variable SPEC_FILE. For example:

export SPEC_FILE="./specs/mytestapi.json"
yarn dev

License

Apache 2.0