TODO/WIP: Write a gem description
Integrates swagger-ui with your "grapified" Rails 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:
And then execute:
Or install it yourself as:
$ gem install grape-swagger-ui
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
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)
- 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!