Skip to content

PavloBilyak/try_api

 
 

Repository files navigation

TryApi

Gem Version Code Climate Issue Count

Simple autogenerated live API documentation for Rails applications.

Installation

Add this line to your application's Gemfile:

gem 'try_api'

And then execute:

$ bundle

This will generate config file example:

$ rails generate try_api:install

Mount try_api engine to your routes. Add this to routes.rb

mount TryApi::Engine => '/developers'

Usage

Modify config/try_api/base.yml

Contributing

Bug reports and pull requests are welcome:

  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

The gem is available as open source under the terms of the MIT License.

About

Generates UI for rails apps with APIs. You can easily test, share and play with you'r API. Enjoy )

Resources

Code of conduct

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages