Skip to content
Rspec Api Documentation Browser
Find file
Pull request Compare This branch is 74 commits behind smartlogic:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
config.ru
raddocs.gemspec

README.md

Travis status

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/
Something went wrong with that request. Please try again.