https://github.com/markbates/api_doc

Easily generate API docs from RSpec/Rails
https://github.com/markbates/api_doc

Last synced: about 1 year ago
JSON representation

Easily generate API docs from RSpec/Rails

• Host: GitHub
• URL: https://github.com/markbates/api_doc
• Owner: markbates
• License: mit
• Created: 2012-02-27T20:56:36.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2023-01-19T00:43:25.000Z (over 3 years ago)
• Last Synced: 2025-04-20T04:34:22.565Z (about 1 year ago)
• Language: Ruby
• Homepage: http://www.metabates.com
• Size: 78.1 KB
• Stars: 7
• Watchers: 1
• Forks: 7
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ApiDoc

A quick and easy way to generate pretty API documentation for a Rails application using your (Rspec) controller specs.

## Installation

Add this line to your application's Gemfile:

    gem 'api_doc'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install api_doc

## Usage

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 spec/spec_helper.rb:


    require "api_doc/rspec"

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

Finally, run rake api:doc command and visit /api_docs to browse the generated documentation.

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Added some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request