How to automatically generate API documentation for Rails REST controller?
Is there any example I can look into using RDoc to do this?
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/.
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!
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With