Grape-Doc

It's a Grape documentation generator for lazy developers. The main goal is to make as clean and useful documentation as possible for 3. party developers to your application without sharing anything from the code.

The Documentation generator it self is a little evil because it not force but really count on it, that you make test for your api endpoints. For now it's all based on rack-test, but support will be given for other testing frameworks too.

But dont misunderstand this, it can live without it, you just have to do more support for the others, because the documentation will lack curl samples and sample response body and stuffs like that.

$ gem install grape-doc

gem 'grape-doc'

    GrapeDoc.generate
    #> this will create an api_doc.html in the project_folder/doc
    

I Would suggest run minitests first, with including all the test in the test folder that touch anything with your grape api classes. Because a rack-test-poc , there will be generated yaml files in the test/poc folder

    GrapeDoc.generate   format: 'redmine', # or textile, or html
                        path: File.join(__dir__,'..........')
                        

well that was complex! right?

I would strongly suggest using Grape build in desc method for api endpoints, and define every parameters ahead, so they will be included in the documentation, and validated on request!