Raddocs is a browser for JSON outputted by the rspec_api_documentation gem.
Gemfile
gem 'raddocs'config/routes.rb
mount Raddocs::App => "/docs"Make sure RspecApiDocumentation is generating JSON:
spec/spec_helper.rb
RspecApiDocumentation.configure do |config|
config.format = :json
endapi_name- Name of the API on the example index pagedocs_dir- where the JSON output from rspec_api_documentation is locateddocs_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/include_bootstrap- Boolean to disable including bootstrap if you are using your own cssexternal_css- Array of css files to include, with a full URL to them
You can include extra css by the config option external_css or add a directory to the docs dir named styles. Every css file in the styles dir will be included as a link element on all pages.