ruby-on-rails – 如何使用Rails中的REST API构建好的文档?

目前,我正在Rails中构建RESTful Web服务.我正在寻找一些方法来在我的Rails RESTful Web服务中构建一个很好的文档.我找到了一些方法:

> Wiki如Twitter API
> RDoc
> WADL(我不知道有没有人正在使用它?)

有人可以提出任何建议吗?

解决方法

如果您的意思是要为您的路由可用的每个URI生成文档,则不遵循REST的约束. RESTful API只能具有您的入口点URI.您的媒体类型的描述显示了如何通过嵌入在响应超文本中的URI来发现其他资源.所以,没有自动的方法来做到这一点.

Sun Cloud API一个很好的例子.

相关文章

validates:conclusion,:presence=>true,:inclusion=>{...
一、redis集群搭建redis3.0以前,提供了Sentinel工具来监控各...
分享一下我老师大神的人工智能教程。零基础!通俗易懂!风趣...
上一篇博文 ruby传参之引用类型 里边定义了一个方法名 mo...
一编程与编程语言 什么是编程语言? 能够被计算机所识别的表...
Ruby类和对象Ruby是一种完美的面向对象编程语言。面向对象编...