API中JSON格式部分编辑的常见行为及字段处理咨询

刚巧处理过不少类似的API设计场景，结合你给出的用户初始数据{ nickname: "foo", firstName: "John", lastName: "Doe" }，我来拆解下三种操作对应的常见API处理逻辑：

1. 「编辑」字段：更新为新值 #

当用户修改了某个字段的内容并保存时，前端需要将该字段的新值包含在请求JSON中，API会将对应字段替换为新值，未提及的字段保持原有状态。

举个例子：用户把nickname改成"bar"，请求JSON应该是：

{ "nickname": "bar" }

API处理后的用户数据会变成：

{ nickname: "bar", firstName: "John", lastName: "Doe" }

这种逻辑是HTTP PATCH方法的标准语义——仅更新请求中指定的字段。

2. 「清空」字段：显式设为null #

用户主动清空文本字段并保存时，前端必须**显式将该字段的值设为null**并包含在请求里，API收到后会把对应字段更新为null（前提是业务允许该字段为空）。

比如用户清空firstName字段，请求JSON是：

{ "firstName": null }

API处理后的数据变为：

{ nickname: "foo", firstName: null, lastName: "Doe" }

这里要注意：绝对不能省略这个字段，因为省略会被API判定为「保持原样」，不会触发清空操作。

3. 「保持原样」：省略字段或发送空对象 #

如果用户没有修改某个字段，前端就不要把该字段包含在请求JSON中，API会默认保留该字段的原有值。

比如用户只修改了lastName为"Smith"，请求JSON是：

{ "lastName": "Smith" }

处理后的数据是：

{ nickname: "foo", firstName: "John", lastName: "Smith" }

如果用户啥都没改就点了保存，前端可以发送一个空对象{}，API收到后直接返回原数据，不做任何更新。

额外的最佳实践 #

• 优先使用HTTP PATCH方法来处理这种部分更新场景，PUT方法一般用于全量替换（需要传所有字段），不适合你的需求。
• 一定要在API文档里明确说明规则：省略字段=保持原样，传null=清空字段，传有效值=修改字段，避免前后端出现理解偏差。
• 前端要做好字段状态判断：当用户清空字段时，必须主动把字段值设为null再发送请求，而不是直接移除这个字段。

内容的提问来源于stack exchange，提问作者omriki