ColumbusX-API OpenAPI Specification

Links

• Reference Documentation (ColumbusX-API)
• OpenAPI Raw Files: JSON YAML

Warning: All above links are updated only after Travis CI finishes deployment

Working on specification

Install

1. Install Node JS
2. Clone repo and run npm install in the repo root

Usage

npm start

Starts the development server.

Development server started 🎉 :

✔ Documentation (ReDoc): http://localhost:8080

✔ Swagger Editor: http://localhost:8080/swagger-editor/

Visit http://localhost:8080/swagger-editor/ and edit and commit

npm run build

Bundles the spec and prepares web_deploy folder with static assets.

npm test

Validates the spec.

npm run gh-pages

Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.