How to auto generate Rails REST API documentation for controllers?

Question

How to automatically generate API documentation for Rails REST controller?

Is there any example I can look into using RDoc to do this?

Answer 1

Use http://techblog.floorplanner.com/2008/05/07/rapidoc-rails-rest-api-documentation-generation-well-just-rapidoc/

Answer 2

You don't understand what REST is. The only URI in your API documentation for a RESTful service should be the entry point. Everything else is communicated through hypertext. If not, then your service is not REST and should not be called as such.

See this article by Roy Fielding, the creator of REST.