gravadigital/grunt-baucis-swagger2

grunt-baucis-swagger2

Generates a swagger.json from baucis router.

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-baucis-swagger2 --save-dev

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

grunt.loadNpmTasks('grunt-baucis-swagger2');

The "baucis_swagger2" task

Overview

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

grunt.initConfig({
  baucis_swagger2: {
    options: {
      src: '/home/user/mymodelfolder', // absolute path of the mongoose model's folder
      dest: '/home/user/baucis.json' // absolute path of the output file
    },
  },
});

Options

src

The string of the source file.

dest

The string of the destination file.

Usage Example

grunt.initConfig({
  baucis_swagger2: {
    production:{
        src: '/home/user/myproyect/lib/models',
        dest: '/home/user/myproyect/swagger/baucis.json'
    },
  },
});

Development

Local testing

npm run test