Integrates swagger-ui with rails asset pipeline
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
lib
vendor/assets
.gitignore
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
Rakefile
grape-swagger-ui.gemspec

README.md

Grape::Swagger::Ui

Code Climate

TODO/WIP: Write a gem description

Integrates swagger-ui with your "grapified" Rails application.

Dependencies

Add swagger compliant documentation to your grape API

An opinionated micro-framework for creating REST-like APIs in Ruby

Installation

Add this line to your application's Gemfile:

gem 'grape-swagger-ui'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grape-swagger-ui

Usage example:

class YourAPI < Grape::API
  version 'v1'
  format :json
  ...
  add_swagger_documentation :add_version => true,
                            :base_path => '/api'
end

See https://github.com/ruby-grape/grape-swagger#configure for more configuration settings.

If your api path is "api/v1" just go to

http://host:port/api/swagger

else

Generate the main layout for customizations

rails generate swagger:layout [TEMPLATE_ENGINE]

and change the initializer. Currently supported: ERB, HAML, SLIM.

Since this is a seperate layout and if you want to use this in your staging environment you need to precompile it.

#staging.rb
config.assets.precompile += %w(swagger_ui.js swagger_ui.css swagger_ui_print.css swagger_ui_screen.css)

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

MIT License, full text of license see here

Free Software, Fuck Yeah!