使用RESTful处理子对象上的CRUD
如果通过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指向一个已经存在的资源,那么封闭的实体应该被认为是驻留在原始服务器上的修改版本。 如果Request-URI不指向现有资源,并且该URI可以被请求用户代理定义为新资源,则源服务器可以使用该URI创建资源。 如果创建了新资源,源服务器必须通过201(创建)响应通知用户代理。 如果现有资源被修改,则应发送200(OK)或204(无内容)响应代码以指示成功完成请求。 如果无法使用Request-URI创建或修改资源,则应该给出适当的错误响应,以反映问题的性质。 实体的接收者不得忽略任何它不理解或实现的Content- *(例如Content-Range)头,并且在这种情况下必须返回501(未实现)响应。
根据我对REST的理解,书籍是资源,应该通过自己的端点进行处理,并且应该只使用目录的更新将现有书籍添加到目录中,而不是创建它们。
因此,在这种情况下,直到创建请求被提交来创建书籍时,不存在的书籍将被忽略/不添加到目录。
这意味着用户将发送一个POST / book来创建该书,然后在该请求中添加PUT到/ catalog,并将其添加到目录中。
你是对的。 你在这里有两个不同的资源。 一个被命名为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。 在我看来,这是没有道理的。
你正在尝试做的是批量/批量更新。 据我所知。 我们没有共识如何做到这一点。 这里有很多问题:
/catalog
(因此存储中的每本书都是这样),您必须提供整个目录的表示形式。 您应该考虑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: eg link relation
)。 所以你应该考虑添加链接到你通过GET返回的资源表示,并且可能使用超媒体格式,例如HAL + XML或者ATOM + XML。
上一篇: Handling CRUD on child objects with RESTful
下一篇: Can PHP cURL retrieve response headers AND body in a single request?