0.0
No commit activity in last 3 years
No release in over 3 years
Autodoc for Grape API specs.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.9
= 4.2.0
>= 0

Runtime

>= 0.14.0
 Project Readme

Autodoc::Grape

Extend r7kamura/autodoc to generate documention for Grape API.

Installation

Add this line to your application's Gemfile:

gem 'autodoc-grape'

Example

Grape API params block

params do
  requires :id, type: Integer
  optional :hash, type: Hash do
    requires :attr, type: String
  end
end

Generated Parameter Section

### Parameters
* id Integer (required)
* hash Hash
 * attr String (required)

Supported Parameter Options

The following are all valid options.

  • required
  • values
  • default
  • description