# Swagger::UiRails

A gem that lets you add [swagger-ui](https://github.com/wordnik/swagger-ui) easily to your rails application

Compatible with rails 5

Current version: 2.2.8.2

## Installation

Add this line to your application's Gemfile:

    gem 'swagger-ui_rails5'

## Usage

Add to your application.js

    //= require swagger-ui

Add to your application.css

    *= require swagger-ui

Then add to some api_docs/index.html

    = render 'swagger_ui/swagger_ui', discovery_url: 'root/to/swagger_doc.json'

or create your own html page according to [swagger-ui sample](https://github.com/swagger-api/swagger-ui/blob/master/dist/index.html)

Swagger UI expects a body class of `swagger-section`. If you can't easily add that class to body in your layout, you can add it to a parent div, e.g.:

    %div.swagger-section
      = render 'swagger_ui/swagger_ui', discovery_url: 'root/to/swagger_doc.json'

## Related projects

[Grape](https://github.com/intridea/grape)
[grape-swagger](https://github.com/tim-vandecasteele/grape-swagger)

## 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