A quick and easy way to generate pretty API documentation for a Rails application using your (Rspec) controller specs.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install api_doc
Prepare your Rails project by running the generator inside your project:
rails g api_doc:install
This will copy over the appropriate assets and mount the engine routes.
Next, add the following to your
Then tag each controller spec that you want to document like so:
describe 'index' do it 'returns a list of questions', :api_doc => true do get :index response.status.should be(200) end end
rake api:doccommand and visit /api_docs to browse the generated documentation.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request