{"repo":"zipmark/rspec_api_documentation","free":true,"listed":false,"github":"https://github.com/zipmark/rspec_api_documentation","clone":"git clone https://github.com/zipmark/rspec_api_documentation.git","description":"Automatically generate API documentation from RSpec","language":"Ruby","stars":1451,"topics":["rspec","api","ruby"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"RSpec API Doc Generator Generate pretty API docs for your Rails APIs. Check out a sample. Changes Please see the wiki for latest changes. Installation Add rspec api documentation to your Gemfile gem 'rspec api documentation' Bundle it! $ bundle install Set up specs. $ mkdir spec/acceptance $ vim spec/acceptance/orders spec.rb Generate the docs! $ rake docs:generate $ open doc/api/index.html Viewers Consider adding a viewer to enhance the generated documentation. By itself rspec api documentation will generate very simple HTML. All viewers use the generated JSON. Raddocs - Sinatra app Apitome - Rails engine Gemfile gem 'raddocs' or gem 'apitome' spec/spec helper.rb For both raddocs and apitome, start rails server. Then open http://localhost:3000/docs for raddocs or http://localhost:3000/api/docs for apitome Sample App See the example folder for a sample Rails app that has been documented. The sample app demonstrates the :open api format. Example of spec file Configuration options Format json : Generates an index file and example files in JSON. html : Generates an index file and example files in HTML. combined text : Generates a single file for each resource. Used by Raddocs for command line docs. combined json : Generates a single file for all examples. json iodocs : Generates I/O Docs style documentation. textile : Generates an index file and example files in Textile. markdown : Generates an index file and example files in Markdown. api blueprint : Generates an index file and","default_branch":null,"files":null,"tree":[],"storefront":"/r/zipmark","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/zipmark/rspec_api_documentation/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}