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

发布时间：2020-12-16 19:36:51 所属栏目：百科来源：网络整理

导读：目前,我正在Rails中构建RESTful Web服务.我正在寻找一些方法来在我的Rails RESTful Web服务中构建一个很好的文档.我找到了一些方法： Wiki如Twitter API RDoc WADL(我不知道有没有人正在使用它？) 有人可以提出任何建议吗？解决方法如果您的意思是要为您的

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

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

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

解决方法

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

见Sun Cloud API一个很好的例子.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!