Swaggerator creates swagger docs and definitions by reading your source code (route.rb and controllers) and interpreting the request parameters.
To execute
rake swaggerator:define will define a swag/define.yml file which scans and creates a definition file. The definition file contains request params, route params, etc and can be edited.
rake swaggerator:generate will generate a swag/swagger.json file which contains the actuall swagger specifications.
Add this line to your application's Gemfile:
gem 'swaggerator'And then execute:
$ bundle
Or install it yourself as:
$ gem install swaggerator
TODO: Write usage instructions here
After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/kieraya/swaggerator.
The gem is available as open source under the terms of the MIT License.