如何设计Restful API的分页?

需要考虑的问题:

  • 请求方式
  • 回复方式

请求方式

可考虑的传递通道:

  • url query, /foo?page=1
  • url path, /foo/page/1
  • http request json body
  • http header

比较:

  • page不是resource,所以不应该设计在url path中
  • 需要考虑到url复制分享和传统a标签兼容问题的情况,这里还不谈及SEO,所以应该来说url query还是最优选择

数据格式:

  • 基于page, [page:4, per_page:50]
  • 基于offset, [offset:200, limit: 50]
  • 基于cursor, [cursor: timestamp, limit: 50]

page和offset比较简单,但是在large datasets查询时会效率比较低,没有索引,所以才会有cursor方式,但是考虑到github, zoom,同时兼顾client的友好性,采用page-based还是比较折中的选择。

  • ?page=2&size=100: 指定第几页,以及每页的记录数
  • ?offset=100&limit=10: 指定返回记录的数量
  • ?sort=name+,group-: 多属性排序

回复方式

  • json
  • http header

github比较特殊,采用了将pagination信息已link方式放在了http header中,http body就是比较纯粹的array,所以github翻页也只有上一页,下一页。

一般来说,用json更多一些,回复内容包括:

  • total: 总数
  • page: 当前页数 (1-based)
  • size: 当前每页数量
  • items: 具体记录数组
  • 0
    点赞
  • 2
    收藏
  • 打赏
    打赏
  • 4
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:大白 设计师:CSDN官方博客 返回首页
评论 4

打赏作者

nonocast

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值