grunt-swagger-gennerate v0.6.0

grunt-swagger-gennerate

plugin grunt swagger

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-swagger-gennerate --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-swagger-gennerate');

The "swagger_gennerate" task

Overview

In your project's Gruntfile, add a section named swagger_gennerate to the data object passed into grunt.initConfig().

grunt.initConfig({
  swagger_gennerate: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.separator

Type: String Default value: ', '

A string value that is used to do something with whatever.

options.punctuation

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  swagger_gennerate: {
    options: {},
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
});

Custom Options

In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

grunt.initConfig({
  swagger_gennerate: {
    options: {
      baseDir: __dirname,
      separator: ': ',
      punctuation: ' !!!',
    },
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
});

Custom dir Options

In this example, custom dir are used to do with any directory we fill to options in grunt file of modules and sure that directory of output file has created.

grunt.initConfig({
  swagger_gennerate: {
    options: {
      baseDir: __dirname,
      outPut: '/doc/swagger.json',
      paths: [
          '/backend/webserver/api/*.js',
          '/backend/webserver/api/*.js',
          '/backend/webserver/api/*.js',
          '/backend/webserver/api/*/*.js',
          '/modules/*/backend/webserver/**/*.js'
        ],
      corePaths: []
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)