REST API最佳实践:在哪里放置参数?

REST API可以至少以两种方式拥有参数:

作为url路径的一部分(即/api/resource/parametervalue) 作为查询参数(例如/api/resource?=参数值)

这里的最佳实践是什么?什么时候使用1，什么时候使用2，有什么一般的指导方针吗?

真实世界的例子:Twitter使用查询参数来指定间隔。(http://api.twitter.com/1/statuses/home_timeline.json?since_id=12345&max_id=54321)

把这些参数放在URL路径中会被认为是更好的设计吗?

当前回答

这是个很有趣的问题。

你可以同时使用它们，关于这个主题没有任何严格的规则，但是使用URI路径变量有一些优点:

缓存: 大多数互联网上的web缓存服务不缓存GET请求时，他们包含查询参数。他们这样做是因为有很多RPC系统使用GET请求来更改服务器中的数据(失败!!)Get必须是一个安全的方法)

但是如果使用路径变量，所有这些服务都可以缓存GET请求。

层次结构: 路径变量可以表示层次结构: /城市/街道/的地方

它为用户提供了关于数据结构的更多信息。

但如果你的数据没有任何层次关系，你仍然可以使用Path变量，使用逗号或分号:

/城市/经度,纬度

作为规则，当参数的顺序重要时使用逗号，当顺序不重要时使用分号:

/ IconGenerator /红色,蓝色,绿色

除了这些原因之外，在某些情况下，使用查询字符串变量是非常常见的:

当您需要浏览器自动将HTML表单变量放入URI时当你处理算法的时候。例如谷歌引擎使用查询字符串:

http:// www.google.com/search ? q =休息

总而言之，没有任何强烈的理由使用这种方法，但只要可以，就使用URI变量。

2015-02-13 09:12:21

其他回答

如果有记录在案的最佳实践，我还没有找到它们。然而，当我决定在url中放置参数时，这里有一些指导原则:

可选参数往往更容易放在查询字符串中。

如果您希望在参数值与现有资源不对应时返回404错误，那么我倾向于使用路径段参数。例如:/customer/232，其中232不是有效的客户id。

然而，如果你想返回一个空列表，那么当参数没有找到时，我建议使用查询字符串参数。例如/联系人吗?name =戴夫

如果一个参数影响URI空间的整个子树，则使用路径段。例如，语言参数/en/document/foo.txt和/document/foo.txt?语言= en

我希望唯一标识符位于路径段中，而不是查询参数中。

uri的官方规则可以在这个RFC规范中找到。这里还有另一个非常有用的RFC规范，它定义了参数化uri的规则。

2010-10-26 23:33:52

在我看来，参数应该更好地作为查询参数。url用于标识资源，而添加的查询参数用于指定您想要的资源的哪一部分、资源应该具有的任何状态等等。

2010-10-26 13:52:00

这个主题的一个“维度”被忽略了，但它非常重要:有时“最佳实践”必须与我们正在实现或增强REST功能的平台相一致。

实际的例子:

现在许多web应用程序都实现了MVC(模型、视图、控制器)架构。他们假设提供了一个特定的标准路径，当那些web应用程序带有“启用SEO url”选项时更是如此。

这里只提一个相当有名的网络应用程序:OpenCart电子商务商店。当管理员启用“SEO url”，它期望说url来一个相当标准的MVC格式，如:

http://www.domain.tld/special-offers/list-all?limit=25

在哪里

special-offers是处理URL的MVC控制器(显示special-offers页面) List-all是控制器要调用的动作或函数名。（*） Limit =25是一个选项，表示每页将显示25个项目。

(*) list-all是我使用的一个虚构的函数名。实际上，OpenCart和大多数MVC框架都有一个默认的、隐含的(通常在URL中省略)索引函数，当用户想要执行默认操作时，就会调用该索引函数。真实世界的URL是:

http://www.domain.tld/special-offers?limit=25

现在有了一个类似于上面的相当标准的应用程序或框架结构，你经常会得到一个针对它进行优化的web服务器，为它重写URL(真正的“非SEOed URL”应该是:http://www.domain.tld/index.php?route=special-offers/list-all&limit=25)。

因此，作为开发人员，你要面对的是处理现有的基础设施，并适应你的“最佳实践”，除非你是系统管理员，确切地知道如何调整Apache / NGinx重写配置(后者可能很讨厌!)等等。

因此，你的REST API通常会更好地遵循参考web应用程序的标准，无论是一致性还是易用性/速度(从而节省预算)。

回到上面的实际例子，一个一致的REST API应该是类似这样的url:

http://www.domain.tld/api/special-offers-list?from=15&limit=25

或者(非SEO URLs)

http://www.domain.tld/index.php?route=api/special-offers-list?from=15&limit=25

使用“路径形成”参数和“查询形成”参数的混合。

2014-07-03 11:52:33