代码之家  ›  专栏  ›  技术社区  ›  Harish Shetty

自记录REST接口

  •  8
  • Harish Shetty  · 技术社区  · 15 年前

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

    理想情况下,我希望在服务器端使用一个拦截器,该拦截器将基于现有流量记录服务。我想知道有没有宝石可以做这个。

    2 回复  |  直到 15 年前
        1
  •  2
  •   kashahkashah    13 年前

    Darrel和Jon是正确的,我还要补充一点,您的API应该在它的根上是可发现的。应提供读写操作。

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

        2
  •  1
  •   Darrel Miller    15 年前

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

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