REST和null中的补丁

Question

我们有一个属性为的文章资源：

• 标题
• 图像
• 描述: __________
• 状态：已发布|草稿

如果我们只想删除图像，我们提出请求

{title: null, image: null, description: null, status: null}

如果我们只想更新状态，我们会提出请求

{title: null, image: null, description: null, status: draft}

但在这种情况下，图像也将被删除。

如何在REST中只更新一个属性？

Answer 1

让我举一个例子，当在 RESTFul API 的补丁消息中使用 JSON 补丁消息时，这让我感到困扰。如果我们有这样的结构：

{"books": [
   {"title": "HTTP-Protocol", "image": "http.jpg", "description": "A standard book on HTTP", "status": "Available"},
   {"title": "JSON-Patch", "image": "patching.jpg", "description": "Explanation on how to use json-patch in RESTFul", "status": "Planned"},
   {"title": "RESTFul", "image": "fielding.jpg", "description": "Representational state transfer", "status": "Available"}
]}

现在请求此信息的客户端希望将第三本书（RESTFul）的状态从“可用”更改为“已借”。使用JSON-Patch，他将发送以下消息：

[
    {
        "op": "replace",
        "path": "/books/2/status",
        "value": "Borrowed"
    }
]

这意味着从列表中，正如他所见，他想更改第三项的状态。但是由于RESTFul API调用是无状态的，服务器不再知道它给客户端的列表是什么。也许同时添加了一本新书，服务器上的列表更改为：

{"books": [
   {"title": "HTTP-Protocol", "image": "http.jpg", "description": "A standard book on HTTP", "status": "Available"},
   {"title": "In between", "image": "destroy.jpg", "description": "Not RESTFul?", "status": "Available"},
   {"title": "JSON-Patch", "image": "patching.jpg", "description": "Explanation on how to use json-patch in RESTFul", "status": "Planned"},
   {"title": "RESTFul", "image": "fielding.jpg", "description": "Representational state transfer", "status": "Available"}
]}

那么从客户端收到的这个json-patch消息将改变标题为“JSON-Patch”的书，而不是客户端想要的标题为“RESTFul”的书。

你认为这个问题的解决办法是什么？

Answer 2

PATCH方法可用于对资源执行部分修改。请求有效负载应该包含一组说明如何修改资源的指令。请参阅RFC 5789中的以下引用：

2.PATCH方法

PATCH 方法请求将请求实体中描述的一组更改应用于由请求 URI 标识的资源。[...]

PUT 和 PATCH 请求之间的差异反映在服务器处理封闭的实体以修改由请求 URI 标识的资源的方式上。在 PUT 请求中，包含的实体被视为存储在源服务器上的资源的修改版本，客户端请求替换存储的版本。但是，使用 PATCH，随附的实体包含一组说明，描述应如何修改当前驻留在源服务器上的资源以生成新版本。[...]

要描述这样一组指令，您可以使用RFC 6902中定义的JSON补丁：

1.简介

json补丁是一种格式(由媒体类型< code > application/JSON-Patch JSON 标识),用于表达应用于目标JSON文档的操作序列；它适合与HTTP PATCH方法一起使用。

在其他需要对JSON文档或具有类似约束的数据结构进行部分更新的情况下，此格式也可能有用[…]

要更新状态，您可以执行以下操作：

PATCH /articles/1 HTTP/1.1
Host: example.com
Content-Type: application/json-patch+json

[
  { "op": "replace", "path": "/status", "value": "draft" }
]

使用以下命令删除该映像：

PATCH /articles/1 HTTP/1.1
Host: example.com
Content-Type: application/json-patch+json

[
  { "op": "remove", "path": "/image" }
]

并使用以下命令更新状态并删除图像:

PATCH /articles/1 HTTP/1.1
Host: example.com
Content-Type: application/json-patch+json

[
  { "op": "replace", "path": "/status", "value": "draft" },
  { "op": "remove", "path": "/image" }
]

作为JSON Patch的替代方案，您可能需要考虑在RFC 7396中定义的JSON Merge Patch：它也是一种描述对目标资源内容的一组修改的方法。