index.js

/**
 * Our hook
 */

const _path = require('path');

var swaggerDoc = require("./lib/swaggerDoc");

module.exports = function (sails) {

  let routes = [];

  return {

    // capture the bound Sails routes
    _routes: routes,

    defaults: {
      disabled: false,
      __configKey__: {
        swaggerJsonPath: _path.join(sails.config.appPath, '/swagger/swagger.json'),
        swagger: {
          openapi: '3.0.0',
          info: {
            title: 'Swagger Json',
            description: 'This is a generated swagger json for your sails project',
            termsOfService: 'http://example.com/terms',
            contact: {
              name: 'Theophilus Omoregbee',
              url: 'http://github.com/theo4u',
              email: 'theo4u@ymail.com'
            },
            license: { name: 'Apache 2.0', url: 'http://www.apache.org/licenses/LICENSE-2.0.html' },
            version: '1.0.0'
          },
          servers: [
            { url: 'http://localhost:1337/' }
          ],
          externalDocs: { url: 'http://theophilus.ziippii.com' }
        }
      }
    },
    // Run when sails loads-- be sure and call `next()`.
    initialize: function (next) {

      // https://github.com/balderdashy/sails/blob/master/lib/EVENTS.md#routerbind
      sails.on('router:bind', (routeObj) => {
        routes.push(routeObj);
      });

      sails.after('ready', () => {
        swaggerDoc(sails, routes, this);
      });
      next();
    }

  };
};