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路径中会被认为是更好的设计吗?
当前回答
根据REST实现，
1)路径变量用于对资源的直接操作，如联系人或歌曲 前女友. . 获取etc /api/resource/{songid}或 GET etc /api/resource/{contactid}将返回相应的数据。
2)查询perms/参数用于间接资源，如一首歌的元数据 . ., GET / api /资源/ {songid} ?Metadata =genre它将返回特定歌曲的类型数据。
其他回答
以下是我的观点。
查询参数被用作请求的元数据。它们充当现有资源调用的过滤器或修饰符。
例子:
/ / 2014-08-08 /日历事件
应该给出当天的日历事件。
如果需要特定类别的事件
/日历/ 2014-08-08 /事件吗?类别=约会
或者你需要超过30分钟的比赛
/日历/ 2014-08-08 /事件吗?时间= 30
试金石测试是检查在没有查询参数的情况下是否仍然可以提供请求。
我通常倾向于#2，作为查询参数(即/api/resource?=参数值)。
第三种选择是将parameter=value放到函数体中。
这是因为它可以更好地用于多参数资源，并且具有更强的可扩展性以供将来使用。
不管你选哪一个，确保你只选一个，不要混搭。这导致了一个令人困惑的API。
如果有记录在案的最佳实践，我还没有找到它们。然而，当我决定在url中放置参数时，这里有一些指导原则:
可选参数往往更容易放在查询字符串中。
如果您希望在参数值与现有资源不对应时返回404错误，那么我倾向于使用路径段参数。例如:/customer/232，其中232不是有效的客户id。
然而，如果你想返回一个空列表，那么当参数没有找到时，我建议使用查询字符串参数。例如/联系人吗?name =戴夫
如果一个参数影响URI空间的整个子树，则使用路径段。例如，语言参数/en/document/foo.txt和/document/foo.txt?语言= en
我希望唯一标识符位于路径段中，而不是查询参数中。
uri的官方规则可以在这个RFC规范中找到。这里还有另一个非常有用的RFC规范，它定义了参数化uri的规则。
根据URI标准，路径用于层次参数，查询用于非层次参数。离岸金融中心。对你来说什么是等级制度是非常主观的。
在将多个uri分配给相同资源的情况下，我喜欢将用于标识的参数放入路径中，将用于构建表示的参数放入查询中。(对我来说，这种方式更容易路由。)
例如:
/users/123和/users/123?字段= "姓名、年龄" /users和/users?name = " John "年龄= 30
对于map reduce，我喜欢使用以下方法:
/用户?name = " John "年龄= 30 /用户/名称:约翰/年龄:30岁
因此，如何构造uri实际上取决于您(以及您的服务器端路由器)。
注意:只是提到这些参数是查询参数。因此，您真正要做的是定义一种简单的查询语言。对于复杂查询(包含与、或、大于等操作符)，我建议您使用已经存在的查询语言。URI模板的功能非常有限…
回答晚了，但我将对已经分享的内容添加一些额外的见解，即请求有几种类型的“参数”，您应该考虑到这一点。
定位器——例如资源标识符，如id或操作/视图 过滤器——例如，提供搜索、排序或缩小结果集的参数。 状态-例如会话标识，api密钥，等等。 内容-例如要存储的数据。
现在，让我们看看这些参数可能发生的不同情况。
请求报头和cookie URL查询字符串("GET"变量) URL路径 正文查询字符串/多部分("POST" vars)
通常，您希望在头文件或cookie中设置State，这取决于它是哪种类型的状态信息。我想我们都同意这一点。如果需要，使用自定义http报头(X-My-Header)。
类似地，Content只有一个归属位置，即在请求体中，可以作为查询字符串，也可以作为http multipart和/或JSON内容。这与服务器向您发送内容时您从服务器接收到的内容一致。所以你不应该无礼，用不同的方式去做。
像“id=5”或“action=refresh”或“page=2”这样的定位器作为URL路径是有意义的，例如mysite.com/article/5/page=2，其中您部分知道每个部分的含义(例如article和5显然意味着为我获取id为5的article类型的数据)，并且附加参数被指定为URI的一部分。它们的形式可以是page=2，或者page/2，如果您知道URI中的某个点之后，“文件夹”是成对的键-值。
过滤器总是在查询字符串中，因为尽管它们是查找正确数据的一部分，但它们只是返回Locators单独返回的数据的子集或修改。在mysite.com/article/?query=Obama(子集)中的搜索是一个过滤器，/article/5?顺序向后=(修改)。想想它是做什么的，而不仅仅是它的名字!
如果“view”决定输出格式，那么它是一个过滤器(mysite.com/article/5?view=pdf)，因为它返回对找到的资源的修改，而不是指向我们想要的资源。如果它决定我们可以看到文章的哪个特定部分(mysite.com/article/5/view=summary)，那么它就是一个定位器。
记住，缩小一组资源就是筛选。在资源中定位某个特定的东西就是定位…咄。子集筛选可以返回任意数量的结果(甚至是0)。定位总是会找到某事物的特定实例(如果它存在)。修改筛选将返回与定位器相同的数据，除了被修改(如果允许这样的修改)。
如果人们不知道该把东西放在哪里，希望这能给他们一些顿悟的时刻!
