CenitIO APIv2 Specifications

View-On-Line

Introduction

This repo has official reference of the CenitIO APIv2 specifications. The spec is OpenAPI 3.0.0 (aka swagger).

Links

• Reference Documentation (ReDoc)
• 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

Starts the development server for API Specification:

npm start

Build web_deploy folder with static assets:

npm run build

Validates the API specifications:

npm test

Deploys to GitHub Pages:

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

npm run gh-pages