Question

如果通过PUT（意图更新目录）将以下xml请求发送到名为/ catalog的RESTful API端点。

如果用户提供了请求中目录中不存在的其他<book>端点是否应“创建”它们？或者应该忽略它们，也可以使用不同的端点/书籍来创建它们。

<?xml version="1.0"?>
<catalog>
   <book id="bk101">
      <author>Gambardella, Matthew</author>
      <title>XML Developer's Guide</title>
      <genre>Computer</genre>
      <price>44.95</price>
      <publish_date>2000-10-01</publish_date>
      <description>An in-depth look at creating applications 
      with XML.</description>
   </book>
   <book id="bk102">
      <author>Ralls, Kim</author>
      <title>Midnight Rain</title>
      <genre>Fantasy</genre>
      <price>5.95</price>
      <publish_date>2000-12-16</publish_date>
      <description>A former architect battles corporate zombies, 
      an evil sorceress, and her own childhood to become queen 
      of the world.</description>
   </book>
   <book id="bk103">
      <author>Corets, Eva</author>
      <title>Maeve Ascendant</title>
      <genre>Fantasy</genre>
      <price>5.95</price>
      <publish_date>2000-11-17</publish_date>
      <description>After the collapse of a nanotechnology 
      society in England, the young survivors lay the 
      foundation for a new society.</description>
   </book>
   <book id="bk104">
      <author>Corets, Eva</author>
      <title>Oberon's Legacy</title>
      <genre>Fantasy</genre>
      <price>5.95</price>
      <publish_date>2001-03-10</publish_date>
      <description>In post-apocalypse England, the mysterious 
      agent known only as Oberon helps to create a new life 
      for the inhabitants of London. Sequel to Maeve 
      Ascendant.</description>
   </book>
   <book id="bk105">
      <author>Corets, Eva</author>
      <title>The Sundered Grail</title>
      <genre>Fantasy</genre>
      <price>5.95</price>
      <publish_date>2001-09-10</publish_date>
      <description>The two daughters of Maeve, half-sisters, 
      battle one another for control of England. Sequel to 
      Oberon's Legacy.</description>
   </book>
   <book id="bk106">
      <author>Randall, Cynthia</author>
      <title>Lover Birds</title>
      <genre>Romance</genre>
      <price>4.95</price>
      <publish_date>2000-09-02</publish_date>
      <description>When Carla meets Paul at an ornithology 
      conference, tempers fly as feathers get ruffled.</description>
   </book>
   <book id="bk107">
      <author>Thurman, Paula</author>
      <title>Splish Splash</title>
      <genre>Romance</genre>
      <price>4.95</price>
      <publish_date>2000-11-02</publish_date>
      <description>A deep sea diver finds true love twenty 
      thousand leagues beneath the sea.</description>
   </book>
   <book id="bk108">
      <author>Knorr, Stefan</author>
      <title>Creepy Crawlies</title>
      <genre>Horror</genre>
      <price>4.95</price>
      <publish_date>2000-12-06</publish_date>
      <description>An anthology of horror stories about roaches,
      centipedes, scorpions  and other insects.</description>
   </book>
   <book id="bk109">
      <author>Kress, Peter</author>
      <title>Paradox Lost</title>
      <genre>Science Fiction</genre>
      <price>6.95</price>
      <publish_date>2000-11-02</publish_date>
      <description>After an inadvertant trip through a Heisenberg
      Uncertainty Device, James Salway discovers the problems 
      of being quantum.</description>
   </book>
   <book id="bk110">
      <author>O'Brien, Tim</author>
      <title>Microsoft .NET: The Programming Bible</title>
      <genre>Computer</genre>
      <price>36.95</price>
      <publish_date>2000-12-09</publish_date>
      <description>Microsoft's .NET initiative is explored in 
      detail in this deep programmer's reference.</description>
   </book>
   <book id="bk111">
      <author>O'Brien, Tim</author>
      <title>MSXML3: A Comprehensive Guide</title>
      <genre>Computer</genre>
      <price>36.95</price>
      <publish_date>2000-12-01</publish_date>
      <description>The Microsoft MSXML3 parser is covered in 
      detail, with attention to XML DOM interfaces, XSLT processing, 
      SAX and more.</description>
   </book>
   <book id="bk112">
      <author>Galos, Mike</author>
      <title>Visual Studio 7: A Comprehensive Guide</title>
      <genre>Computer</genre>
      <price>49.95</price>
      <publish_date>2001-04-16</publish_date>
      <description>Microsoft Visual Studio 7 is explored in depth,
      looking at how Visual Basic, Visual C++, C#, and ASP+ are 
      integrated into a comprehensive development 
      environment.</description>
   </book>
</catalog>

我在SO上发现了很多关于PUT与POST以及在根对象上进行CRUD操作的最佳实践，但我花了一夜时间试图找到有关如何处理子对象的信息。

根据http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html，我不清楚这是否适用于儿童对象？

9.6 PUT

PUT方法请求将所包含的实体存储在   提供了Request-URI。如果Request-URI引用已存在的URI   资源，封闭的实体应该被视为修改过的   驻留在源服务器上的版本。如果是Request-URI   不指向现有资源，并且该URI能够   被请求用户代理定义为新资源   origin服务器可以使用该URI创建资源。如果是新资源   创建后，源服务器必须通过201通知用户代理   （创建）响应。如果修改了现有资源，则为   应该发送200（OK）或204（No Content）响应代码以指示   成功完成请求。如果资源不能   使用Request-URI创建或修改了一个适当的错误   应该给出反映问题性质的回应。该   实体的接收者绝不能忽略任何Content- *（例如   它不理解或实现的内容范围标题   在这种情况下必须返回501（未实现）响应。

根据我对REST的理解，书籍是资源，应该通过自己的端点进行处理，目录的更新只应用于将现有书籍添加到目录中，而不是创建它们。

因此，在此方案中，在提交创建请求以创建书籍之前，不会存在/不会将不存在的书籍添加到目录中。

这意味着用户会发送一个POST /书来创建这本书，然后在请求中将该PUT转至/目录，并将其添加到目录中。

Answer 1

你是对的。这里有两种不同的资源。一个名为Books，另一个名为Catalogs。您必须设计两个不同的URI来处理每个URI。所以在这种情况下，我会创建两个不同的资源来处理这个问题。第一个资源将命名为/ catalogs，您必须将其构建为仅接收某人想要与此目录关联的书籍ID（一个或多个）。你会：

Endpoint -> https://yourapi.com/catalogs

POST to https://yourapi.com/catalogs --> creates a new catalog.
PUT to https://yourapi.com/catalogs/1 --> updates the catalog with ID = 1.
PUT to https://yourapi.com/catalogs/2 where id 2 doesn't exist --> creates a new catalog with id=2

您必须将以下XML发送到上面指出的端点。

<?xml version="1.0"?>
<catalog>
    <book id="bk101"/>
    <book id="bk102"/>
    <book id="bk103"/>
    <book id="bk104"/>
<catalog>

第二个资源应该是/ books，您必须使用它来创建，删除，更新和列出书籍。一旦您创建了一本书，就可以将其与目录相关联。您不应该使用资源目录以这种方式创建Book。在我看来，它没有意义。

Answer 2

您要做的是批量/批量更新。据我所知。我们没有达成共识如何做到这一点。这里有很多问题：

应该通过更新整个资源来使用PUT。由于资源是/catalog（因此存储中的每本书都是这样），因此您必须表示整个目录。您应该考虑使用PATCH，它可以用于部分更新。
PUT是幂等的。因此，如果您发送两次PUT，它不应该有任何副作用。这就是为什么只有当用户提供新资源的ID时才能使用PUT进行创建的原因。（否则你会创建两次新资源。）PATCH不是幂等的，所以2：0到PATCH。

您可以在此处找到有关PATCH的说明：PATCH Method for HTTP。

但是，使用PATCH，随附的实体包含一组说明资源当前如何驻留在应修改原始服务器以生成新版本。 PATCH 方法影响Request-URI标识的资源，它也是可能对其他资源产生副作用;即，新资源可能是通过应用PATCH创建或修改现有的。

所以PATCH /catalog和你的XML就可以了。您可以决定是否允许用户提供新资源的ID，或者您可以在服务器端生成它。

OFC。您有其他选择，例如您可以使用POST /catalog发送图书集，因此将创建多个图书资源。您可以使用PUT /catalog/?id="bk112,bk113,..."更新特定的图书集。正如您已经提到的，另一种替代方法是逐个创建所有内容。

请注意，我们正在讨论超链接（METHOD /resource-id?query <data /> + link metadata: e.g. link relation）。因此，您应该考虑添加指向您通过GET返回的资源表示的链接，并且可能也使用超媒体格式，例如HAL + XML或ATOM + XML。

使用RESTful处理子对象上的CRUD

2 个答案: