api-docs-builder/README.md

Utility function for building Swagger API Docs

# NPM Module Boilerplate

[![Build Status](https://travis-ci.org/yusufnb/api-spec-builder.svg?branch=master)](https://travis-ci.org/yusufnb/api-spec-builder) [![dependencies Status](https://david-dm.org/yusufnb/api-spec-builder/status.svg)](https://david-dm.org/yusufnb/api-spec-builder) [![devDependencies Status](https://david-dm.org/yusufnb/api-spec-builder/dev-status.svg)](https://david-dm.org/yusufnb/api-spec-builder?type=dev) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

**API Spec Builder**

Utility functions to incrementally build Swagger API Specs from within your controllers

# Commands
- `npm run clean` - Remove `lib/` directory
- `npm 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-config
- `npm 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