API分页最佳实践

Question

我希望一些帮助处理一个奇怪的边缘案例与我正在构建的一个分页API。

与许多API一样，这个API分页了大量的结果。如果查询/foos，将得到100个结果（即foo#1-100)，以及一个指向/foos？page=2的链接，该链接将返回foo#101-200。

不幸的是，如果在API使用者进行下一个查询之前从数据集中删除了foo#10，/foos？page=2将抵消100并返回foos#102-201。

这对于试图拉动所有foos的API消费者来说是一个问题--他们不会收到foo#101。

处理这件事的最佳做法是什么？我们希望使它尽可能轻量级（即避免处理API请求的会话）。来自其他API的示例将非常感谢！

Answer 1

我不完全确定您的数据是如何处理的，所以这可能工作，也可能不工作，但是您考虑过用时间戳字段分页吗？

当您查询/foos时，会得到100个结果。然后，您的API应该返回如下内容（假设是JSON，但如果需要XML，则可以遵循相同的原则）：

{
    "data" : [
        {  data item 1 with all relevant fields    },
        {  data item 2   },
        ...
        {  data item 100 }
    ],
    "paging":  {
        "previous":  "http://api.example.com/foo?since=TIMESTAMP1" 
        "next":  "http://api.example.com/foo?since=TIMESTAMP2"
    }

}

仅仅是一个注释，仅使用一个时间戳依赖于结果中隐含的‘限制’。您可能希望添加显式限制或同时使用until属性。

可以使用列表中的最后一个数据项动态地确定时间戳。这似乎或多或少是Facebook在其Graph API中分页的方式（向下滚动到底部可以看到我上面给出的格式的分页链接）。

一个问题可能是，如果您添加了一个数据项，但根据您的描述，听起来它们会被添加到最后（如果不是，请告诉我，我会看看是否可以改进这一点）。