自我记录REST接口

时间:2010-04-16 00:41:41

标签: ruby-on-rails rest activeresource

我有一个运行多个REST服务的基于Rails的服务器和一个基于Rails的Web UI,它使用ActiveResource与服务器交互。其他客户端正在使用相同的服务器(例如:mobile)。我必须为REST接口生成文档。我需要为每个服务提供服务URL,输入/输出和错误文档结构。

理想情况下,我想在服务器端使用拦截器,它将根据现有流量记录服务。我想知道是否有宝石可以做到这一点。

2 个答案:

答案 0 :(得分:2)

Darrel和Jon是正确的,我还要补充一点,你的API应该可以在它的根目录中被发现。应该提供读写操作。

查看Jon Moore的演讲,以便在http://vimeo.com/20781278

进一步讨论

答案 1 :(得分:1)

在应用REST架构样式时,无需记录界面。

客户端和服务器之间的合同是根据使用的媒体类型建立的,如果您需要任何其他附加文档,那么您就不是RESTful。

因此,不要担心记录您的服务,而是将所有描述性工作放入媒体类型的文档中。有关媒体类型的知识是实现服务器客户端所必需的。