REST数组操作最佳实践

Question

3

我可以通过REST完全访问foo资源：

{
  "name": "foo",
  "tags": [
    "tag01",
    "tag02",
    "tag03"
  ]
}

我想删除tags数组中的tag01。

通常情况下，我会进行GET \foo和PUT \foo操作，但不包括tag01。在这种情况下，由于对象很小，所以这样做是可以的。

但是，如果对象很大，我就不想下载并上传这些数据了。经过一些谷歌搜索，我发现了http PATCH。它看起来正是我需要的。

我的PATCH请求如下：

PATCH /foo/tags?op={add|delete}

删除的话，我会使用：

PATCH /foo/tags?op=delete

使用这个数据：

{
  "value": "tag01"
}

现在有两个我不喜欢的事情：

我觉得这看起来不正确。

有没有其他通过REST操作数组的方法？

在PATCH方式中有没有一些命名惯例？

- Walery Strauch

2个回答

1

有没有其他通过REST操作数组的方法？

有，因为这不正确。在REST中，您将URL映射到资源（而不是操作），并使用HTTP方法和发送表示来操作资源。在URL或表示中具有op:remove是错误的。

是否有一些命名约定可以以PATCH方式执行它？

没有REST命名约定。URI结构对REST客户端无关，因为他们遵循带有语义注释的超链接。

如果您需要在某个地方使用op:remove或类似的内容，则表明您的URI-资源映射不好。可能需要定义新资源或重新考虑资源结构。

我会将您想要的描述为批量创建和批量删除。您可以使用以下内容对此进行建模：

要从集合中删除某些内容，您需要一个资源标识符URI。在这种情况下，这可以包含标记名称或数组中的索引（如果有序）。

由您决定，但我会使用标记名称。

之后就很简单了：

因此，PATCH 不是您正在寻找的方法，因为您正在创建和删除资源，而不是替换它们。

- inf3rno

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- lefloh · Accepted Answer

PATCH的负载应该包含“描述驻留在原始服务器上的资源如何修改以生成新版本的指令”。所有信息都应该在负载中传递，而不是在查询参数中传递。

例如，您可以发送：

PATCH /foo

[
  { 
    "op": "remove",
    "path": "/tags/0" 
  }
]

路径/tags/0指向数组的第一个元素。其余元素应向左移动。

有关更多详细信息，请参见JSON Patch草案。