在API中,分页应该是零索引吗?

The*_*ist 19 api rest api-design

在实现具有分页参数的Rest API时,分页应该是零索引或从1开始.参数将是Page和PageSize.

对我来说,从1开始是有意义的,因为我们正在讨论页面

cas*_*lin 15

它没有标准.只需浏览一下:有数十万个API使用不同的方法.

我知道的大多数API使用以下方法之一进行分页:

  • offsetlimit
  • pagesize

两者都可以01索引.哪个更好?随你(由你决定.

只需选择适合您需求的文件并妥善记录.


此外,您可以在响应有效负载中提供一些链接,以使页面之间的导航更容易.

例如,考虑从第2页读取数据.因此,请提供上一页(第1页)和下一页(第3页)的链接:

{
    "data": [
        ...
    ],
    "paging": {
        "previous": "http://api.example.com/foo?page=1&size=10", 
        "next": "http://api.example.com/foo?page=3&size=10" 
    }
}
Run Code Online (Sandbox Code Playgroud)

请记住,总是制作一个喜欢使用的API .