Project

raddocs

0.05
No commit activity in last 3 years
No release in over 3 years
Browse documentation generated by the rspec_api_documentation gem
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.3
~> 0.6
~> 10.0
~> 3.0

Runtime

>= 4.0
>= 0
~> 2.0
 Project Readme

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/