如何设计获取用户列表接口:获取全部用户列表 及 分页获取用户列表?
问大家一个接口设计的问题,比如获取用户列表,有两个需求:
1:获取全部用户列表
2:以分页形式获取用户列表
大家一般会把接口设计成什么样的?
按照我之前的习惯:获取单个用户 GET /users/:id
在有需求1时,我把接口设计为: GET /users
但是当遇到需求2时,本来打算设计为 GET /users 参数:page、pageSize。如果传入 page pageSize 即为分页,否则默认不分页。
但是此时有个需求,如果客户端没有传入,希望后端默认有个分页(是有这么个鬼畜的需求,历史遗留问题),所以此时 API 设计就不能只用 /users,会发生冲突。
想问一下大家,这种情况下 需求2 如何设计 API 呢?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
个人觉得不宜给前端过多的参数。
其次,可以 ,再加一个路由,指向那个方法。然后方法加参数,放在后端去处理。
已有分页接口的话,个人倾向于不再提供获取全部的接口。
如果这个“获取全部”有最大数量限制,那么调用分页接口设置页码为1,分页大小为限制值即可;如果“没有限制”,那就传个
1<<30
(1073741824)吧。你问要是用户数大于1<<30怎么办?
500万个手机号码的文本都有将近60MB大小了,超过10亿的用户信息……,你确定要通过接口一次性传输那么多数据吗,服务器吃得消吗?网络吃得消吗