api-docs-builder
v0.1.1
Published
Utility function for building Swagger API Docs
Downloads
5
Maintainers
Readme
NPM Module Boilerplate
API Spec Builder
Utility functions to incrementally build Swagger API Specs from within your controllers
Commands
npm run clean
- Removelib/
directorynpm test
- Run tests with linting and coverage results.npm test:only
- Run tests without linting or coverage.npm test:watch
- You can even re-run tests on file changes!npm test:prod
- Run tests with minified code.npm run test:examples
- Test written examples on pure JS for better understanding module usage.npm run lint
- Run ESlint with airbnb-confignpm run cover
- Get coverage report for your code.npm run build
- Babel will transpile ES6 => ES5 and minify the code.npm run prepublish
- Hook for npm. Do all the checks before publishing your module.
Installation
npm install -s api-spec-builder
License
MIT © Yusuf Bhabhrawala