kiote / raddocs

Rspec Api Documentation Browser

Raddocs

Raddocs is a browser for JSON outputted by the rspec_api_documentation gem.

Install

Gemfile

gem 'raddocs'

config/routes.rb

  match "/docs" => Raddocs::App, :anchor => false

Configuration

• api_name - Name of the API on the example index page
• docs_dir - where the JSON output from rspec_api_documentation is located
• docs_mime_type - if you use the middleware, what mime type are you serving your docs as, must be a regex. eg: /text\/vnd.org.oestrich.raddocs\+plain/