api - 用于克隆资源的REST API设计

This question already has answers here:

What is the restful way to represent a resource clone operation in the URL?

(5个答案)

5年前关闭。

我正在使用swagger编写YAML文档，以设计用于克隆资源的RESTful API方法。我有几种选择，不知道哪一种是最好的。有人可以请教吗？
选项:

放弃将资源对象克隆到使用方(使用方将值分配给新对象的属性，然后创建新对象)的责任，该过程将包括对API的两个请求:针对GET的请求源对象的资源，然后对该资源进行POST以创建新对象。 感觉消费者对负有太多责任。

使用WebDAV HTTP扩展提供了COPY方法(see here)。看来这正是我想要克隆的。 但是，我想尽可能地遵循标准方法

张贴到/{resource}？resourceIdToClone = {id} ，其中resourceIdToClone是可选参数。这将与创建资源时已经存在的API路径冲突，在该路径中将架构添加到POST主体。 这意味着对/{resource}/使用POST进行创建和克隆，这将违反SRP。

添加一个名为“CloneableResource”的新资源，然后对/CloneableResource/{resource_type}/{resource_source_id}执行POST。 对于克隆绵羊的示例，您需要对/CloneableResource/Sheep/10进行POST。这样，就可以坚持使用标准的HTTP方法，而不会与任何其他资源路径发生冲突(或违反SRP)。但是，我将向域中添加一个新的并且可能是多余的类型。我也无法想到一个场景，当消费者想要对该资源执行除POST之外的任何操作，因此对我来说似乎是一种代码味道。

针对/resource/{id}？method = clone 的GET。这里的优点之一是不需要额外的资源，它可以由一个简单的可选querystring参数确定。我知道这里的风险之一是，如果URL在网页中，则使用GET方法提供发布或删除功能可能很危险，因为它可能会被搜索引擎抓取。

谢谢你的帮助!

最佳答案

这些选项中的大多数都是非常好的选择。最后，很多只是您的样式选择。这是我对您的每个选择的评论。

放弃将资源对象克隆到使用者的责任
总的来说，我对这个解决方案没有任何疑问。对于用户而言，此选项非常简单明了，易于实现。它可能比提供一些用户必须学习如何使用的专有克隆功能要好。

使用提供了COPY方法的WebDAV HTTP扩展
我也喜欢坚持标准方法。我不会使用COPY，但如果您这样做，我不会感到震惊。

张贴到/{resource}？resourceIdToClone = {id}
这是一个完美的解决方案。从REST的角度来看，您与其他API并没有真正的冲突。具有查询参数的URI与没有查询参数的URI标识的资源不同。查询参数是URI功能，用于标识无法分层引用的资源。但是，由于大多数REST框架的工作方式，可能很难在代码中将它们分开。除了使用诸如/{resource}/clone的分层URI之外，您可以执行与此类似的操作。您可以发布到此URI并在正文中传递resource_source_id。

添加一个名为“CloneableResource”的新资源，并对/CloneableResource/{resource_type}/{resource_source_id}进行POST
从REST的角度来看，这种方法没有错，但是我认为添加新类型既不必要，又会使API困惑。但是，我不同意您的直觉，拥有仅具有POST操作的资源可能会出现问题。它发生了。在现实世界中，并非所有内容都能很好地适合GET，PUT或DELETE。

针对/resource/{id}的GET？method =克隆
这是5个我不能容忍的唯一选择。从您的描述看来，您已经了解为什么这是一个坏主意，所以我不确定您为什么要考虑它。但是，要做到一个好的解决方案，您要做的就是将GET更改为POST。然后，它与＃3解决方案非常相似。 URI也可以是分层的，而不是使用查询参数。 POST /resource/{id}/clone也可以正常工作。

我希望这可以帮到你。祝您好运。

关于api - 用于克隆资源的REST API设计，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/30804876/

上一篇：django - 从所有用户删除 session key

下一篇：objective-c - initWithNibName 到底做了什么？

相关文章：

javascript - AngularJS:带有动态数据的 ng-repeat

java - 如何在java中初始化RESTful Web服务中的一些功能

web-services - Asmx 从 Extjs 接收 POST 值(参数)？

mysql - 我需要3秒的间隔来执行每个mysql_query

Python JSON 纽约时报 API

java - 不应成为公共(public) API 一部分的公共(public)包/类

java - 尝试返回 XML 时 Jersey 返回 500

jquery - 如何使用getJSON，用post方式发送数据？

javascript - 使用媒体流时 Web Audio API : FFT data in firefox differ from those in chrome,？

java - Spring MVC + Rest API - 无法延迟初始化集合