如何设计Restful API的分页?

本文探讨了在设计RESTful API时如何实现分页。建议使用URL查询参数,如?page=1和?size=100来指定页数和每页大小,因为这种方式更利于URL分享和传统A标签兼容。在数据格式方面,比较了基于page、offset和cursor的方法,认为对于大型数据集,cursor方式更有效,但page-based在多数情况下是折衷选择。在回复方式上,推荐通过JSON返回分页信息,包括总记录数、当前页数和每页大小,而GitHub则将分页信息放在HTTP Header的link字段中。
摘要由CSDN通过智能技术生成

需要考虑的问题:

  • 请求方式
  • 回复方式

请求方式

可考虑的传递通道:

  • 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+
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值