JSON API文档工具

问题描述：

是否有工具或简单的方法来生成/维护富RESTful JSON API的文档？JSON API文档工具

我也想发布和维护（作为可执行文档）它，就像relishapp提供的东西。 An example。

该应用程序是Restful Ruby on Rails 3应用程序，使用cucumber和R-Spec控制器测试进行测试。

为什么不使用[rdoc]（http://rdoc.rubyforge.org/）或该家族的某些东西？它将您的源代码的注释转换为api浏览器。 – wulftone

谢谢，这很好。但我想要更像黄瓜，你不断运行（红色/绿色），只是保持。 – jake

答

你说你已经有黄瓜测试 - 他们是你的文档。他们可能只需要一些工作来阅读。

对于输出，您可以使用Cucumber的内置HTML格式器。

是的，我在大多数情况下都这么做，但我正在寻找更适合JSON API的东西，这将有助于开发人员更好地使用JSON API。随着所有的请求响应，参数等，但不必使黄瓜非常冗长。 – jake