22

我想知道如何使用 ASP.NET Web API 的 RESTful 接口实现部分更新？例如，假设我们通过以下结构的线路传递对象：

public class Person {
    public int Id { get; set; }
    public string Username { get; set; }
    public string Email { get; set; }
}

如何支持一次只更新 aPerson的一部分，例如Email属性？是否建议通过OData和 PATCH 动词来实现这一点，还是自己实现 PATCH 更好？

4

1 回答 1

31

当前最新的稳定版 Web API（从 2012 年 8 月开始）不提供支持。因此，如果您只想使用 Web API RTM，则必须自己实现整个管道。

Delta<T>话虽如此，OData 预发布包通过新对象很好地支持部分更新。目前 Microsoft.AspNet.WebApi.OData 包已经是 RC 版本（0.3），可以从这里获得：http ://www.nuget.org/packages/Microsoft.AspNet.WebApi.OData

安装后，您可以相应地使用它：

[AcceptVerbs("PATCH")]
public void Patch(int id, Delta<Person> person)
{
    var personFromDb = _personRepository.Get(id);
    person.Patch(personFromDb);
    _personRepository.Save();
}

你会像这样从客户端调用它：

$.ajax({
    url: 'api/person/1',
    type: 'PATCH',
    data: JSON.stringify(obj),
    dataType: 'json',
    contentType: 'application/json',
    success: function(callback) {            
       //handle errors, do stuff yada yada yada
    }
});

这样做的明显优势是它适用于任何属性，您不必关心是否更新Email或Username诸如此类。

您可能还想查看这篇文章，因为它显示了一种非常相似的技术http://techbrij.com/http-patch-request-asp-net-webapi

编辑（更多信息）： 为了只使用 PATCH，您不需要启用任何与 OData 相关的东西，除了添加 OData 包 - 以访问 Delta<TEntityType>对象。

然后你可以这样做：

public class ValuesController : ApiController
{
    private static List<Item> items = new List<Item> {new Item {Id = 1, Age = 1, Name = "Abc"}, new Item {Id = 2, Age = 10, Name = "Def"}, new Item {Id = 3, Age = 100, Name = "Ghj"}};

    public Item Get(int id)
    {
        return items.Find(i => i.Id == id);
    }

    [AcceptVerbs("PATCH")]
    public void Patch(int id, Delta<Item> item)
    {
        var itemDb = items.Find(i => i.Id == id);
        item.Patch(itemDb);
    }
}

如果您的项目是，让我们说：

{
    "Id": 3,
    "Name": "hello",
    "Age": 100
}

您可以/api/values/3使用以下方法修补：

{
    "Name": "changed!"
}

这将正确更新您的对象。

Delta<TEntity>将为您跟踪更改。它是一个动态类，充当您的类型的轻量级代理，并将了解原始对象（即来自数据库）和客户端传递的对象之间的差异。

这不会以任何方式影响您的 API 的其余部分（当然除了用较新的 DLL 替换 DLL 以促进 OData 包依赖项）。

我添加了一个示例项目来演示 PATCH + Delta 的工作 - 您可以在此处获取它（it.s VS2012）https://www.dropbox.com/s/hq7wt3a2w84egbh/MvcApplication3.zip

于 2013-01-08T16:19:24.777 回答