https://github.com/yusufnb/api-docs-builder

https://github.com/yusufnb/api-docs-builder

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/yusufnb/api-docs-builder
• Owner: yusufnb
• License: mit
• Created: 2021-09-22T22:31:50.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-09-26T21:47:18.000Z (over 3 years ago)
• Last Synced: 2024-12-14T18:48:41.382Z (29 days ago)
• Language: JavaScript
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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