Swagger::Docs::Generator |

Generator for Swagger Apps (Example with theme)

Menu

• How to use
  • Installation
  • Usage
• Development
• Contributing

How to use

Installation

Add this line to your application's Gemfile :

gem 'swagger-docs-generator'

And then execute :

bundle

Or install it yourself as :

gem install swagger_docs_generator

Usage

Create initializer :

rails generator swagger_docs_generator:initializer

Create environment :

rails generator swagger_docs_generator:environment

Execute rake task for generated swagger.json :

rake swagger:docs

Development

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Dev-Crea/swagger-docs-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.