rest - 如何在 REST API 中定义编辑页面？

Question

在我正在设计的 Play 应用中，这些是我的一些路线

POST    /visits                     controllers.Visit.create
GET     /visits                     controllers.Visit.visits
GET     /visits/:id                 controllers.Visit.visit(id: Long)
PUT     /visits/:id                 controllers.Visit.update(id: Long)
DELETE  /visits/:id                 controllers.Visit.delete(id: Long)

我也支持浏览器界面。我正在按照我在这里看到的指导进行操作: RESTful on Play! framework

我可以轻松地提供一个 HTML 模板来显示有关一次特定访问或访问列表的详细信息。但是，“编辑页面”如何干净地落入其中，必须预先填充来自特定访问的信息？我可以轻松地执行以下操作:GET/visits/:id/edit controllers.Visit.edit(id: Long) 这将返回一个预填充了访问信息的页面，或者我可以有一个静态 HTML通过 AJAX 调用调用 /visits/:id 来填充字段的页面，这可以让我避免使用特定于浏览器页面的路由破坏我的资源驱动 API。或者有更好的选择吗？什么是最佳实践，为什么？

Answer 1

在 REST 中，仅仅为了执行标准化操作而创建额外的资源是没有意义的。了解 HTTP 协议(protocol)的每个人都知道您的访问对象应该可以通过 PATCH 请求和您想要应用的差异进行编辑，或者通过 PUT 请求将整个资源替换为新资源。为什么要使用 POST 创建自定义和非标准的编辑操作，您必须记录并向所有人解释它是如何工作的？

从这个意义上说，我认为您最好的选择是拥有一个驱动 API 的静态 HTML 页面，使用/visits/:id 上的 GET 来填充字段，并使用编辑后的内容替换/visits/:提交时带有 PUT 的 ID。

但是，请记住，只要您遵守客户端发送的 Accept header ，在您的 API 中使用特定于浏览器页面的路由并没有错。在我的 API 上，当使用 Accept: text/html header 发出请求时，我有时会有一些路由返回资源的人性化表示，因此这是拥有内置管理客户端的简单方法，并且可以轻松探索 API一个浏览器。在 REST 中，API 和 WEB 页面之间的唯一区别是前者以机器友好的格式返回表示，而后者是您希望浏览器在人类友好的文档中呈现的表示。他们都应该有链接和/或表格，其中包含有关如何编辑资源的说明。