自我记录REST接口

Question

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

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

Answer 1

当您应用 REST 架构风格时，您不需要记录您的接口。

客户端和服务器之间的契约是由所使用的媒体类型建立的，如果您需要任何其他附加文档，那么您就不是 RESTful。

因此，不必担心记录您的服务，而是将所有描述性精力投入到媒体类型的记录中。有关媒体类型的知识是为服务器实现客户端所必需的。