ruby-grape / grape

An opinionated framework for creating REST-like APIs in Ruby.
http://www.ruby-grape.org
MIT License
9.88k stars 1.22k forks source link

Support for api-blueprint #627

Open orta opened 10 years ago

orta commented 10 years ago

Hello there, ( sorry for the initial empty issue, writing now. )

There seems to be movement towards standardizing API descriptions in the form of apiblueprint as a human readable markdown endpoint. It would be nice to be able to have other tools deal with showing the routing & API documentation so that they don't have to be maintained in-house.

mbleigh commented 10 years ago

Making it easier to support API documentation systems like Blueprint is part of my motivation for #620 (which I plan to begin implementing soon). I'll likely leave the blueprint-specific implementation to a third-part gem, but it will be a simple matter to reach in and extract the relevant information.

orta commented 10 years ago

@mbleigh if you believe #620 covers the scope of this issue, I'm happy to close it/

dblock commented 10 years ago

Lets leave this open, since the general issues in #620 should be motivated by more specific target implementations, like the one requested here.