Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to auto generate Rails REST API documentation for controllers? [closed]

Tags:

How to automatically generate API documentation for Rails REST controller?

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

like image 339
Teo Choong Ping Avatar asked Jun 10 '09 02:06

Teo Choong Ping


2 Answers

You can try apipie-rails which I created: https://github.com/Pajk/apipie-rails/

It can do more things than just generate documentation, more info on https://github.com/Pajk/apipie-rails/.

like image 137
Pavel Avatar answered Oct 14 '22 22:10

Pavel


I found https://github.com/zipmark/rspec_api_documentation to be a really nice tool. It's driven off of rspec acceptance tests so you're writing documentation at the same time you're writing acceptance tests! Double win!

like image 23
glamouracademy Avatar answered Oct 14 '22 20:10

glamouracademy