这是这个问题的一个更通用的重新表述(消除了Rails特定的部分)

我不确定如何在RESTful web应用程序中实现资源分页。 假设我有一个叫做产品的资源,你认为以下哪一个是最好的方法,为什么:

1. 只使用查询字符串

如。http://application/products?page=2&sort_by=date&sort_how=asc 这里的问题是,我不能使用全页缓存,而且URL不是很干净,容易记住。

2. 使用页面作为资源和查询字符串进行排序

如。http://application/products/page/2?sort_by=date&sort_how=asc 在这种情况下,我们看到的问题是http://application/products/pages/1不是唯一的资源,因为使用sort_by=price可以产生完全不同的结果,我仍然不能使用页面缓存。

3.使用页面作为资源,并使用URL段进行排序

如。http://application/products/by-date/page/2 我个人认为使用这种方法没有问题,但有人警告我这不是一个好的方法(他没有给出理由,所以如果你知道为什么不推荐,请告诉我)

任何建议,意见,批评都是非常欢迎的。谢谢。


当前回答

我以前用过解决方案3(我写了很多django应用程序)。我不认为这有什么问题。它就像其他两个一样可生成(以防你需要做一些大规模的刮擦或类似的事情),它看起来更干净。另外,你的用户可以猜网址(如果它是一个面向公众的应用程序),人们喜欢能够直接去他们想去的地方,猜网址感觉很强大。

其他回答

我同意Fionn的观点,但我还要进一步说明,对我来说Page不是资源,而是请求的属性。这使得我只选择选项1查询字符串。感觉很好。我真的很喜欢Twitter API的结构。不太简单,也不太复杂,有很好的文档。无论是好是坏,这是我的“go to”设计,当我在做某件事的一种方式和另一种方式之间犹豫不决时。

我倾向于同意slf的观点,即“页面”并不是真正的资源。另一方面,选项3更干净,更容易阅读,用户可以更容易地猜到,甚至在必要时输入。我在选项1和选项3之间犹豫不决,但没有任何理由不使用选项3。

另外,虽然它们看起来很好,但使用隐藏参数的一个缺点,而不是查询字符串或URL段,用户不能收藏或直接链接到特定的页面。根据应用程序的不同,这可能是问题,也可能不是问题,但只是需要注意的问题。

我更喜欢使用查询参数offset和limit。

偏移量:用于集合中项目的索引。

限制:为项目的数量。

客户端可以简单地继续更新偏移量,如下所示

offset = offset + limit

下一页。

路径被认为是资源标识符。页面不是资源,而是资源集合的子集。由于分页通常是一个GET请求,因此查询参数最适合用于分页,而不是用于标头。

参考:https://metamug.com/article/rest-api-developers-dilemma.html # Requesting-the-next-page

我以前用过解决方案3(我写了很多django应用程序)。我不认为这有什么问题。它就像其他两个一样可生成(以防你需要做一些大规模的刮擦或类似的事情),它看起来更干净。另外,你的用户可以猜网址(如果它是一个面向公众的应用程序),人们喜欢能够直接去他们想去的地方,猜网址感觉很强大。

为了寻找最佳实践,我看到了这个网站:

http://www.restapitutorial.com

在参考资料页中有一个链接,可以下载一个.pdf文件,其中包含作者建议的完整REST最佳实践。其中有一节是关于分页的。

作者建议同时支持使用Range头和使用查询字符串参数。

请求

HTTP报头示例:

Range: items=0-24

查询字符串参数示例:

GET http://api.example.com/resources?offset=0&limit=25

其中offset是开始项数,limit是返回的最大项数。

响应

响应应该包括一个Content-Range报头,指示有多少项正在返回,以及总共有多少项尚待检索

HTTP报头示例:

Content-Range: items 0-24/66

Content-Range: items 40-65/*

在.pdf文件中,还有一些针对更具体情况的其他建议。