我正在为客户管理系统编写一个RESTful服务,并试图找到部分更新记录的最佳实践。例如,我希望调用者能够使用GET请求读取完整的记录。但是为了更新它,只允许对记录进行某些操作,比如将状态从ENABLED更改为DISABLED。(我有比这更复杂的场景)

出于安全原因,我不希望调用者只提交更新字段的整个记录(这也感觉有点过分)。

是否有构造uri的推荐方法?在阅读REST书籍时,RPC样式的调用似乎是不受欢迎的。

如果下面的调用返回id为123的客户的完整客户记录

GET /customer/123
<customer>
    {lots of attributes}
    <status>ENABLED</status>
    {even more attributes}
</customer>

我该如何更新状态?

POST /customer/123/status
<status>DISABLED</status>

POST /customer/123/changeStatus
DISABLED

...

更新:扩充问题。如何将“业务逻辑调用”合并到REST api中?有没有大家都同意的做法?并非所有的方法本质上都是CRUD。有些更复杂,如“sendEmailToCustomer(123)”,“mergeCustomers(123, 456)”,“countCustomers()”

POST /customer/123?cmd=sendEmail

POST /cmd/sendEmail?customerId=123

GET /customer/count 

当前回答

你基本上有两个选择:

Use PATCH (but note that you have to define your own media type that specifies what will happen exactly) Use POST to a sub resource and return 303 See Other with the Location header pointing to the main resource. The intention of the 303 is to tell the client: "I have performed your POST and the effect was that some other resource was updated. See Location header for which resource that was." POST/303 is intended for iterative additions to a resources to build up the state of some main resource and it is a perfect fit for partial updates.

其他回答

您应该使用POST进行部分更新。

要更新客户123的字段,需要POST到/customer/123。

如果你只想更新状态,你也可以PUT到/customer/123/status。

通常,GET请求不应该有任何副作用,而PUT用于写入/替换整个资源。

这直接来自HTTP,如这里所示:http://en.wikipedia.org/wiki/HTTP_PUT#Request_methods

对于修改状态,我认为RESTful方法是使用描述资源状态的逻辑子资源。当你有一个减少的状态集时,这个IMO非常有用和干净。它使您的API更具表现力,而无需强制对客户资源进行现有操作。

例子:

POST /customer/active  <-- Providing entity in the body a new customer
{
  ...  // attributes here except status
}

POST服务应该返回新创建的带有id的客户:

{
    id:123,
    ...  // the other fields here
}

创建的资源的GET将使用资源位置:

GET /customer/123/active

GET /customer/123/inactive应该返回404

对于PUT操作,如果不提供Json实体,它只会更新状态

PUT /customer/123/inactive  <-- Deactivating an existing customer

提供实体将允许您更新客户的内容并同时更新状态。

PUT /customer/123/inactive
{
    ...  // entity fields here except id and status
}

您正在为客户资源创建概念子资源。这也符合Roy Fielding对资源的定义:“……资源是到一组实体的概念映射,而不是在任何特定时间点对应映射的实体……”在本例中,概念映射是ACTIVE -customer到status=ACTIVE的客户。

读操作:

GET /customer/123/active 
GET /customer/123/inactive

如果您在另一个调用之后进行这些调用,其中一个必须返回状态404,那么成功的输出可能不包括状态,因为它是隐式的。当然你仍然可以使用GET /customer/123?status=ACTIVE|INACTIVE,直接查询客户资源。

DELETE操作很有趣,因为语义可能令人困惑。但是您可以选择不发布这个概念资源的操作,或者根据您的业务逻辑使用它。

DELETE /customer/123/active

它可以将您的客户带到DELETED/DISABLED状态或相反的状态(ACTIVE/INACTIVE)。

关于你的更新。

我认为CRUD的概念在API设计方面造成了一些混乱。CRUD是对数据执行基本操作的一般低级概念,HTTP谓词只是请求方法(创建于21年前),可能映射到CRUD操作,也可能不映射到CRUD操作。事实上,请尝试在HTTP 1.0/1.1规范中找到CRUD首字母缩写。

在谷歌云平台API文档中可以找到一个应用实用约定的解释很好的指南。它描述了创建基于资源的API背后的概念,一个强调大量资源而不是操作的API,并包括您正在描述的用例。虽然这只是他们产品的一种惯例设计,但我认为这很有意义。

这里的基本概念(也是产生很多混淆的概念)是“方法”和HTTP动词之间的映射。一件事是定义API将对哪种类型的资源执行什么“操作”(方法)(例如,获取客户列表或发送电子邮件),另一件事是HTTP动词。您计划使用的方法和动词必须有一个定义,以及它们之间的映射。

它还说,当一个操作与标准方法(在本例中是List、Get、Create、Update、Delete)不完全匹配时,可以使用“自定义方法”,比如BatchGet,它根据多个对象id输入检索多个对象,或者SendEmail。

你基本上有两个选择:

Use PATCH (but note that you have to define your own media type that specifies what will happen exactly) Use POST to a sub resource and return 303 See Other with the Location header pointing to the main resource. The intention of the 303 is to tell the client: "I have performed your POST and the effect was that some other resource was updated. See Location header for which resource that was." POST/303 is intended for iterative additions to a resources to build up the state of some main resource and it is a perfect fit for partial updates.

使用PUT更新不完整/部分的资源。

您可以接受jObject作为参数,并解析其值以更新资源。

下面是你可以参考的Java函数:

public IHttpActionResult Put(int id, JObject partialObject) {
    Dictionary < string, string > dictionaryObject = new Dictionary < string, string > ();

    foreach(JProperty property in json.Properties()) {
        dictionaryObject.Add(property.Name.ToString(), property.Value.ToString());
    }

    int id = Convert.ToInt32(dictionaryObject["id"]);
    DateTime startTime = Convert.ToDateTime(orderInsert["AppointmentDateTime"]);
    Boolean isGroup = Convert.ToBoolean(dictionaryObject["IsGroup"]);

    //Call function to update resource
    update(id, startTime, isGroup);

    return Ok(appointmentModelList);
}