Rails RESTful API文档

时间:2013-04-09 13:20:44

标签: ruby-on-rails-3 api documentation yard

我正在搜索支持以下功能的文档框架:

  • 从代码评论生成
  • 检索
  • 样式可自定义
  • NTH:链接引用(如果我引用某个类,类名应该链接到类文档)

我想用它来记录我正在使用的RESTfull API

我知道YARDoc,但收集一些替代品会很好

2 个答案:

答案 0 :(得分:1)

马特·西尔弗曼(Matt Silverman)创建了一个非常全面的列表,列出了现在可用于代码生成文档的内容。

http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html

答案 1 :(得分:0)

除了YARD,您可以使用以下rake任务生成RDOC项目文档:

rake doc:app

在此之后,您的文档将位于doc/app文件夹中,可以通过在浏览器中打开index.html文件来查看。它将包括(当前可能是通用的)doc/README_FOR_APP文件。

希望这会有所帮助:)