问题描述
我正在寻找使用 JSON 实现 PATCH 动词以在 RESTful api 中部分更新名词的实用指南.了解 PATCH 用于部分更新，我们仍然缺乏关于删除键、创建或更新嵌套键和数组的语法的标准化.
I'm looking for a practical guide to implementing the PATCH verb for partial updates of a noun in a RESTful api using JSON. Understanding that PATCH is for partial updates, we lack still standardization around the syntax for deleting keys, creating or updating nested keys, and arrays.
假设我GET一个对象:
// GET users/42
{
id: 42,
name: 'SimpleAsCouldBe',
city: 'San Francisco',
roles: ['viewer','editor'],
posts: {
'01': {},
'02': {},
}
}
...那我想更新一下:
...Then I want to update it:
// PATCH users/42
{
name: 'SimpleGuy', // CLEAR: update the key's value
email: '[email protected]', // CLEAR: add the new key
city: null // UNCLEAR: delete the key?
roles: ['owner'], // UNCLEAR: replace the whole array?
posts: {
'02': { title:'how to pop lock' }, // CLEAR: update nested key
'03': { title:'how to salsa' } // CLEAR: create new nested key
}
notes: {
'01': { title: 'a note title' } // CLEAR (but disallowed?): create wrapping key
}
}
PATCH rfc 说不要创建嵌套键.我认为这是一个规范错误，因为创建嵌套键是明确的.
The PATCH rfc says no to creating nested keys. This is a spec bug, I think, because creating a nested key is non-ambiguous.
我可以发送一个完整的对象差异，比如这个库生成，但这使得添加或更新更详细的密钥的明确案例.
I could send a full object diff, like this library generates, but this makes the clear case of adding or updating a key more verbose.
如何使用 HTTP PATCH 以精益方式处理数组、删除和嵌套键?
How do I handle arrays, deletion, and nested keys in a lean way with HTTP PATCH?
推荐答案
规范 清楚地详细说明如何格式化 PATCH 请求的 JSON 正文.您使用的是完全不同的格式.鉴于此，我对存在歧义并不感到惊讶.身体应该看起来像:
The spec clearly details how to format the JSON body of a PATCH request. You're using a totally different format. Given that, I'm not surprised at all that there is ambiguity. The body should look something like:
[
{ "op": "replace", "path": "/name", "value": "SimpleGuy" },
{ "op": "add", "path": "/email", "value": "[email protected]" },
{ "op": "replace", "path": "/city", "value": null },
{ "op": "replace", "path": "/roles", "value": [ "owner" ] },
{ "op": "add", "path": "/posts/02/title", "value": "how to pop lock" },
{ "op": "add", "path": "/posts/", "value": "03" },
{ "op": "add", "path": "/posts/03/title", "value": "how to salsa" },
{ "op": "add", "path": "/notes", "value": { "title": "a note title" } }
]
返回并阅读规范.它甚至提供了解决您大部分问题的示例.
Go back and read the spec. It even gives examples which address most of your questions.
这篇关于HTTP PATCH:处理数组、删除和嵌套键创建的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！