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路径中会被认为是更好的设计吗?
当前回答
我通常倾向于#2，作为查询参数(即/api/resource?=参数值)。
第三种选择是将parameter=value放到函数体中。
这是因为它可以更好地用于多参数资源，并且具有更强的可扩展性以供将来使用。
不管你选哪一个，确保你只选一个，不要混搭。这导致了一个令人困惑的API。
其他回答
作为一名经常在客户端工作的程序员，我更喜欢使用查询参数。另外，对我来说，它将URL路径从参数中分离出来，增加了清晰度，并提供了更多的可扩展性。它还允许我在URL/URI构建和参数构建器之间有单独的逻辑。
我很喜欢曼努埃尔·阿尔达纳说的另一种选择如果有某种树的话。我可以看到用户特定的部分被树形分开。
这个主题的一个“维度”被忽略了，但它非常重要:有时“最佳实践”必须与我们正在实现或增强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
使用“路径形成”参数和“查询形成”参数的混合。
根据URI标准，路径用于层次参数，查询用于非层次参数。离岸金融中心。对你来说什么是等级制度是非常主观的。
在将多个uri分配给相同资源的情况下，我喜欢将用于标识的参数放入路径中，将用于构建表示的参数放入查询中。(对我来说，这种方式更容易路由。)
例如:
/users/123和/users/123?字段= "姓名、年龄" /users和/users?name = " John "年龄= 30
对于map reduce，我喜欢使用以下方法:
/用户?name = " John "年龄= 30 /用户/名称:约翰/年龄:30岁
因此，如何构造uri实际上取决于您(以及您的服务器端路由器)。
注意:只是提到这些参数是查询参数。因此，您真正要做的是定义一种简单的查询语言。对于复杂查询(包含与、或、大于等操作符)，我建议您使用已经存在的查询语言。URI模板的功能非常有限…
以下是我的观点。
查询参数被用作请求的元数据。它们充当现有资源调用的过滤器或修饰符。
例子:
/ / 2014-08-08 /日历事件
应该给出当天的日历事件。
如果需要特定类别的事件
/日历/ 2014-08-08 /事件吗?类别=约会
或者你需要超过30分钟的比赛
/日历/ 2014-08-08 /事件吗?时间= 30
试金石测试是检查在没有查询参数的情况下是否仍然可以提供请求。
我看到很多REST api不能很好地处理参数。经常出现的一个例子是URI包含个人身份信息。
http://software.danielwatrous.com/design-principles-for-rest-apis/
我认为一个必然的问题是，当一个参数根本不应该是一个参数，而应该被移动到请求的HEADER或BODY。
