grunt-soajs

SOAJS plugin for Grunt

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-soajs --save-dev

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

grunt.loadNpmTasks('grunt-soajs');

The "swagger2soajs" task

Overview

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

Usage Examples

grunt.initConfig({
  swagger2soajs: {
    build: {
        options:{
            op: "generate",
            configPath: __dirname + "/config.js",
            swaggerPath: __dirname + "/swagger.yml"
        }
    },
    rebuild: {
        options:{
            op: "regenerate",
            configPath: __dirname + "/config.js",
            swaggerPath: __dirname + "/swagger.yml"
        }
    }
  }
});

Options

options.op

Type: String Default value: N/A

A string value that defines which operation should be invoked.

options.configPath

Type: String Default value: N/A

A string value that points the location of the config.js of the microservice.

options.swaggerPath

Type: String Default value: N/A

A string value that points the location of the swagger.yml file of the microservice.