Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Adds a task to Rails applications to generate documentation for Grape APIs
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
spec
.cane
.gitignore
.rspec
Fudgefile
Gemfile
Guardfile
LICENSE
README.md
RELEASE_NOTES.md
Rakefile
grape_documenter.gemspec

README.md

GrapeDocumenter

travis-ci Dependency Status Code Climate

This adds a task to Rails Applications to generate documentation for Grape APIs.

Installation

Add this line to your application's Gemfile:

gem 'grape_documenter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install grape_documenter

Usage

Within the root of you Rails Application run the following rake task...

$ bundle exec grape_documenter 'MyApp::Api' '/path/to/docs' --format='html' --mounted-path='/api'

The first argument is the a string of the class of Grape::API. If you have multiple APIs within the same application you can run the task as many times as you like with different output paths.

Specifying output format

Currently 2 formats are supported: 'html'; 'textile'. The default is html. You can change the format as shown above.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Verify that all tests pass (bundle exec fudge build)
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request
Something went wrong with that request. Please try again.