如何设计获取用户列表接口:获取全部用户列表 及 分页获取用户列表?

发布于 2022-09-11 20:29:01 字数 365 浏览 19 评论 0

问大家一个接口设计的问题,比如获取用户列表,有两个需求:
1:获取全部用户列表
2:以分页形式获取用户列表

大家一般会把接口设计成什么样的?

按照我之前的习惯:获取单个用户 GET /users/:id

在有需求1时,我把接口设计为: GET /users
但是当遇到需求2时,本来打算设计为 GET /users 参数:page、pageSize。如果传入 page pageSize 即为分页,否则默认不分页。

但是此时有个需求,如果客户端没有传入,希望后端默认有个分页(是有这么个鬼畜的需求,历史遗留问题),所以此时 API 设计就不能只用 /users,会发生冲突。
想问一下大家,这种情况下 需求2 如何设计 API 呢?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

ま昔日黯然 2022-09-18 20:29:01

个人觉得不宜给前端过多的参数。
其次,可以 ,再加一个路由,指向那个方法。然后方法加参数,放在后端去处理。

/users_total

哭泣的笑容 2022-09-18 20:29:01

已有分页接口的话,个人倾向于不再提供获取全部的接口。

如果这个“获取全部”有最大数量限制,那么调用分页接口设置页码为1,分页大小为限制值即可;如果“没有限制”,那就传个1<<30(1073741824)吧。

你问要是用户数大于1<<30怎么办?
500万个手机号码的文本都有将近60MB大小了,超过10亿的用户信息……,你确定要通过接口一次性传输那么多数据吗,服务器吃得消吗?网络吃得消吗

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文