RspecApiDocs

Use RspecApiDocs to generate API documentation from your RSpec tests.

This gem is still a work in progress.

Add this line to your application's Gemfile:

gem 'rspec_api_docs'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rspec_api_docs

To generate documentation, just run your API tests. eg:

$ rspec spec/controllers/api/

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec_api_docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.