vanuan-sails-swagger

swagger.io integration for sails.js

Usage no npm install needed!

<script type="module">
  import vanuanSailsSwagger from 'https://cdn.skypack.dev/vanuan-sails-swagger';
</script>

README

swagger

swagger.io (v2.0) hook for Sails. The application's models, controllers, and routes are aggregated and transformed into a Swagger Document. Supports the Swagger 2.0 specification.

Install

$ npm install sails-swagger --save

Configuration

// config/swagger.js
module.exports.swagger = {
  /**
   * require() the package.json file for your Sails app.
   */
  pkg: require('../package'),
  ui: {
    url: 'http://swagger.balderdash.io'
  }
};

Usage

After installing and configuring swagger, you can find the docs output on the /swagger/doc route.

License

MIT