什么是 JSON Patch(RFC 6902)?
JSON Patch 是 IETF 定义的 JSON 文档变更标准,使用有序操作数组描述修改。每项操作包含 JSON Pointer 路径,并使用 add、remove、replace、move、copy 或 test 六种动作之一。本工具可以比较源文档与目标文档并生成确定性的 Patch,按顺序应用现有 Patch,还能创建可恢复原始文档的反向 Patch。所有处理均在浏览器本地完成。
如何生成或应用 JSON Patch
- 1在“生成 Patch”模式中,将原始文档粘贴到源 JSON,将期望版本粘贴到目标 JSON。
- 2逐项检查生成的操作,并复制 JSON Pointer 路径、完整正向 Patch 或反向 Patch。
- 3展开修改结果预览,确认生成的操作能够得到期望的目标文档。
- 4在“应用 Patch”模式中,粘贴 JSON 文档及包含 add、remove、replace、move、copy 或 test 的 RFC 6902 操作数组。
- 5根据错误中标明的操作序号修复无效路径或参数,然后复制验证后的 JSON 输出。
JSON Patch 的常见用途
构建 HTTP PATCH 请求体
比较 API 资源的当前版本与编辑后版本,生成 PATCH 接口需要的 RFC 6902 操作数组。
检查配置变更
在把配置更新应用到其他环境前,逐项确认字段操作及转义后的 JSON Pointer 路径。
创建可回退的数据迁移
为更新生成正向 Patch,同时生成能够恢复原始 JSON 文档的反向 Patch。
定位 Patch 失败原因
在本地应用第三方 Patch,准确定位缺失路径、无效数组下标或 test 失败所在的操作序号。
常见问题
支持哪些 JSON Patch 操作?
应用器支持 RFC 6902 的全部六种操作:add、remove、replace、move、copy 和 test。生成器使用 add、remove 和 replace,以确定性的方式描述文档差异,避免依赖不稳定的移动检测。
JSON Patch 和 JSON Merge Patch 有什么区别?
JSON Patch 是 RFC 6902 定义的有序操作数组,可以修改数组、移动值和检查前置条件。JSON Merge Patch 是 RFC 7396 定义的局部 JSON 对象,使用 null 表示删除。两者的媒体类型不同,不能直接互换。
路径中的斜杠和波浪号如何表示?
JSON Pointer 使用 ~0 表示波浪号,使用 ~1 表示属性名内部的斜杠。生成器会自动转义,应用器会拒绝格式错误的转义。
工具会上传我的 JSON 吗?
不会。解析、比较、Patch 生成、验证和应用都在浏览器本地运行,文档和 Patch 不会发送到服务器。