grunt-apiDoc2Swagger
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-apidoc2swagger --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "apiDoc2Swagger" task
Overview
In your project's Gruntfile, add a section named apidoc2swagger
to the data object passed into grunt.initConfig()
.
grunt;
Options.
options.apiProject
Type: String
Default value: 'api_project.json'
A path to your generated api_project.json
options.apiData
Type: String
Default value: 'api_data.json'
A path to your generated api_data.json
options.swagger
Type: String
Default value: 'swagger'
Result target directory path
options.basePath
Type: 'String' Default value: 'http://localhost'
Your server URL if you want to test your API with Swagger-ui
Usage Examples
Default Options
grunt;
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
1.2.0
Swagger 2.0 support
1.1.10
Some bug fixes
1.1.1
First release