sails-swagger-pp v0.4.0

sails-swagger-pp

Just a customized fork of this one: https://github.com/langateam/sails-swagger

Install

$ npm install sails-swagger-pp --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'
  },
  // Optional - Merge swagger doc attributes
  doc: {
    basePath: '/api',
    host: 'http://localhost',
    info: {
      title: 'My API',
      contact: {
        name: "Your Name",
        email: "your.email@support.com"
      }
    },
    securityDefinitions: {
      bearer: {
        in: 'header',
        type: 'apiKey',
        name: 'Authorization'
      }
    },
    schemes: [
        'http'
    ],
    definitions: {
      login: {
        properties: {
          email: {
            format: 'string',
            type: 'string'
          },
          password: {
            format: 'string',
            type: 'string'
          }
        },
        type: "object"
      },
      token: {
        properties: {
          token: {
            format: 'string',
            type: 'string'
          }
        },
        type: "object"
      }
    }
  }
};

Ignore Model in Swagger Definitions

/**
 * Log.js
 *
 * @description :: TODO: You might write a short summary of how this model works and what it represents here.
 * @docs        :: http://sailsjs.org/documentation/concepts/models-and-orm/models
 */
module.exports = {
  swagger: { ignore: true },
  attributes: { }
};

Ignore Controller in Swagger Tags

/**
 * LogController
 *
 * @description :: Server-side logic for managing Logs
 * @help        :: See http://sailsjs.org/#!/documentation/concepts/Controllers
 */
module.exports = {
    $swagger: { ignore: true }
};

Usage

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

You can also overload the swagger attributes by adding a swagger attribute on yours routes:

/**
 * Route Mappings
 * (sails.config.routes)
 *
 * Your routes map URLs to views and controllers.
 *
 * If Sails receives a URL that doesn't match any of the routes below,
 * it will check for matching files (images, scripts, stylesheets, etc.)
 * in your assets directory.  e.g. `http://localhost:1337/images/foo.jpg`
 * might match an image file: `/assets/images/foo.jpg`
 *
 * Finally, if those don't match either, the default 404 handler is triggered.
 * See `api/responses/notFound.js` to adjust your app's 404 logic.
 *
 * Note: Sails doesn't ACTUALLY serve stuff from `assets`-- the default Gruntfile in Sails copies
 * flat files from `assets` to `.tmp/public`.  This allows you to do things like compile LESS or
 * CoffeeScript for the front-end.
 *
 * For more information on configuring custom routes, check out:
 * http://sailsjs.org/#!/documentation/concepts/Routes/RouteTargetSyntax.html
 */

module.exports.routes = {

  /***************************************************************************
   *                                                                          *
   * Make the view located at `views/homepage.ejs` (or `views/homepage.jade`, *
   * etc. depending on your default view engine) your home page.              *
   *                                                                          *
   * (Alternatively, remove this and add an `index.html` file in your         *
   * `assets` directory)                                                      *
   *                                                                          *
   ***************************************************************************/

    '/': {
        view: 'homepage'
    },

  /***************************************************************************
   *                                                                          *
   * Custom routes here...                                                    *
   *                                                                          *
   * If a request to a URL doesn't match any of the custom routes above, it   *
   * is matched against Sails route blueprints. See `config/blueprints.js`    *
   * for configuration options and examples.                                  *
   *                                                                          *
   ***************************************************************************/
   
    '* /swagger/doc': { swagger: { ignore: true } },
    '* /swagger/ui': { swagger: { ignore: true } },

    'post /api/auth': {
        controller: 'AuthController',
        action: 'signIn',
        swagger: {
            summary: 'Login',
            description: 'Login in the API',
             parameters: [
                { in: 'body', name: 'body', required: true, schema: { $ref: '#/definitions/login' } }
            ],
            responses: {
                200: { description: 'Authorization token', schema: { $ref: '#/definitions/token' } }
            }
        }
    },
}

License

MIT