TODO/WIP: Write a gem description
Integrates swagger-ui with your "grapified" Rails3 application.
Add swagger compliant documentation to your grape API
An opinionated micro-framework for creating REST-like APIs in Ruby
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
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
and change the initializer.
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 += ["swagger_ui.css", "swagger_ui.js"]
0.0.2
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
MIT License, full text of license see here
Free Software, Fuck Yeah!