JSPM

api-docs-builder

0.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q29491F
  • License MIT

Utility function for building Swagger API Docs

Package Exports

  • api-docs-builder

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (api-docs-builder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NPM Module Boilerplate

Build Status dependencies Status devDependencies Status License: 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