通过gem的API文档

时间:2012-01-24 06:45:08

标签: ruby-on-rails documentation

我正在尝试通过自动检测端点的输入/输出的更改来生成可以记录API的gem,并生成详细说明API的文档(HTML或其他),可能是以

https://dev.twitter.com/docs/api/1/get/statuses/home_timeline

2 个答案:

答案 0 :(得分:2)

就宝石而言,apipie-rails很不错。它不会自动检测更改本身,但它确实有一个简单的注释性语法。您可以根据测试自动生成文档,并为重复使用的参数组等事项提供一些DRY帮助。

现在,对于完全不同的东西...... apiary根据您的API的降价蓝图(维护在您的回购的根目录)为您提供了许多好东西。维护蓝图不是一个糟糕的代价,考虑到养蜂场,然后提供文档,代码示例,社区评论,甚至代理API服务器,如果你想要。

答案 1 :(得分:0)

这是我所知道的最接近的事情,但它不是一个附加的宝石,而是更多用于构建API的工具,其中包含以下文档:https://github.com/mattetti/Weasel-Diesel