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

Question

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

有什么例子我可以用RDoc来做这个吗？

Answer 1

您可以尝试https://github.com/Pajk/rails-restapi（我为此专门创建的）。

如果你有更好的想法让我知道，我知道这个名字会产生误导。

更新

宝石被重命名为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/generating-api-documentation-with-rapi_doc/

Answer 4

你可以使用“calamum”一个ruby构建程序从yaml文件定义生成一个不错的html api doc。 https://github.com/malachheb/calamum

Answer 5

虽然不是自动，但我使用RESTful API建模语言或RAML来定义和记录我的API。

有Node.js软件包可以将yaml文件转换为漂亮的html文档，例如raml2html。

Answer 6

我还在寻找一个很好的文档工具，可以很容易地集成到rails中。最后，我们构建了自己的rails引擎APIDOCO

但是它不会自动生成文档，但您可以轻松使用它。