Contents

Grape::Swagger::Ui
===============

[![Code Climate](https://codeclimate.com/github/kendrikat/grape-swagger-ui.png)](https://codeclimate.com/github/kendrikat/grape-swagger-ui)

TODO/WIP: Write a gem description

Integrates [swagger-ui] with your "grapified" Rails3 application.

Dependencies
-

* [grape-swagger] 
> Add swagger compliant documentation to your grape API

* [grape] 
> 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
-

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"]
	
Version
--------
0.0.2

## 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][License]

*Free Software, Fuck Yeah!*

[License]: https://github.com/kendrikat/grape-swagger-ui/blob/master/LICENSE.txt "LICENSE"
[grape-swagger]: https://github.com/tim-vandecasteele/grape-swagger
[grape]: https://github.com/intridea/grape
[swagger-ui]: https://github.com/wordnik/swagger-ui/  

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
grape-swagger-ui-0.0.4	README.md
grape-swagger-ui-0.0.3	README.md
grape-swagger-ui-0.0.2	README.md