如何为控制器自动生成Rails REST API文档？

Question

如何自动生成Rails REST控制器的API文档？

有没有任何例子我可以使用RDoc来做这个？

Answer 1

您可以尝试https://github.com/Pajk/rails-restapi(我为此专门创建).

如果你有更好的想法让我知道,我知道这个名字有误导性.

UPDATE

宝石被重命名为apipie-rails:https://github.com/Pajk/apipie-rails/

除了生成文档之外,它可以做更多的事情,更多信息请访问https://github.com/Pajk/apipie-rails/.

Answer 2

我发现https://github.com/zipmark/rspec_api_documentation是一个非常好的工具.它取决于rspec验收测试,因此您在编写验收测试的同时编写文档!双赢!

Answer 3

使用rapi_doc gem。设置非常简单直接。按照本教程进行操作：http://www.rubyglob.com/generate-api-documentation-with-rapi_doc/