在ASP.NET Core WebAPI中实现JSON Merge修补程序

Question

我有兴趣在我的ASP.NET核心WebAPI中添加对部分更新的支持,我只更新调用者提供的资源上的属性,保留排除的属性不变.

对于上下文,假设我有一个资源可以描述如下:

GET /users/1
{
    title: "Mister",
    firstName: "Frederick",
    middleName: "McFeely",
    lastName: "Rodgers"
}

如果我想允许消费者将firstName属性中存储的值从"Frederick"单独更改为"Fred",我应该能够公开PATCH支持JSON Merge Patch 的端点Content-Type,如下所示:

PATCH /users/1
Content-Type: application/merge-patch+json
{
    firstName: "Fred"
}

但是,我认为没有简单的方法可以让我知道这firstName是唯一正在更新的属性.例如,如果我要创建一个接受PATCH动词的控制器,它可以像这样搭建:

[Route("users")]
public class UsersController : Controller {

    [HttpPatch("{userId:int}")]
    public User Patch([FromRoute] int userId, [FromBody] User user) {

        // How do I know which properties were set on User at this point?

    }

}

public class User {

    public String Title { get; set; }
    public String FirstName { get; set; }
    public String MiddleName { get; set; }
    public String LastName { get; set; }

}

但是我没有看到如何提取哪些属性'在JSON对象上定义了键,然后将其作为a User并传递给我的控制器.我不能假设一个值null表示属性被排除,因为调用者可以显式地将可选属性设置为null.

编辑

我知道Microsoft.AspNetCore.JsonPatch库.遗憾的是,这需要调用者使用"[change of changes]"来定义RFC 5789中PATCH描述的内容,我发现它不直观且冗长.我指的是RFC 7396中定义的"JSON Merge Patch" .

Answer 1

我找到了一个有效的库：https : //github.com/Morcatko/Morcatko.AspNetCore.JsonMergePatch

[HttpPatch]
[Consumes(JsonMergePatchDocument.ContentType)]
public void Patch([FromBody] JsonMergePatchDocument<Model> patch)
{
    ...
    patch.ApplyTo(backendModel);
    ...
}

或用于patch.JsonPatchDocument.Operations手动遍历补丁请求字段。

Answer 2

为了打补丁，你必须定义 PatchDocument。

有关更多信息，您可以找到PatchDocument

方法示例。

 [HttpPatch("{userId:int}")]   
 public IActionResult UserPatch(int userId, [FromBody] JsonPatchDocument<User> patchDocument) {

    var user = new User();
    // Because it comes from url.
    user.Id = userId;
    patchDocument.ApplyTo(user);

    // Here you call context or repository to save.

  }

文档示例。

[
  { "op": "replace", "path": "/firstName", "value": "boo" },
]

这会将用户模型中的firstName 字段更新为“boo”。