Skip to content

grey-systems/mtc-online-api-docs

Repository files navigation

MTC Customer Online API OpenAPI Specification

Build Status

Links

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

Working on specification

Install

  1. Install Node JS v10.x.x (or use a version manager for NodeJS like NVM)
  2. Clone repo and cd
    • Run npm install (or npm ci if prefer a clean install, without update package-lock.json dependencies)

Usage

  1. Run npm start
  2. Checkout console output to see where local server is started. You can use all links (except preview) by replacing https://grey-systems.github.io/mtc-online-api-docs/ with url from the message: Server started <url>
  3. Make changes using your favorite editor or swagger-editor (look for URL in console output)
  4. All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change TIP: you can open swagger-editor, documentation and swagger-ui in parallel
  5. Once you finish with the changes you can run tests using: npm test
  6. Share you changes with the rest of the world by pushing to GitHub 😄

About

Documentation for mtc-online-api

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published