Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 605 Bytes

API_documentation.md

File metadata and controls

25 lines (17 loc) · 605 Bytes

API Documentation

We have provided offline static API documentation HTML server for developers.

To use the API documentation, please read the following instructions.

  • Install JSdoc globally.
$ npm install -g jsdoc
  • Install the development dependencies under project root (finalhandler and serve-static).
$ npm install
  • Run compilation under project root and serve the page.
$ npm run docs
  • API documentation page will be served at port 8080.

  • Now you may visit http://localhost:8080 to view the API documentations.