微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

REST GET 查询参数建议

如何解决REST GET 查询参数建议

我可能让这变得比它应该的更复杂,但我想知道什么是 GET 端点搜索资源的一个或多个实体的“良好实践”。我也想让它们很容易“全部”。对于上下文,我希望人们能够查找与位于多个(300-400 和不断增长)位置的 productId 相关联的详细信息。对于少数位置来说,这不是一项繁重的操作,但如果用户想要返回所有相关位置,这可能是一个昂贵的 API 调用

以下哪个最好?

使用列表指定哪些位置,如果未提供,则假设“所有位置”

/product/{productId}/search?locations=[1,2,3]

创建一个 allLocations 查询参数来指定用户想要查看所有位置

/product/{productId}/search?allLocations=True

解决方法

  • 首先,您可以使用逗号分隔的值代替数组。
?location=1,2,3

// Then in backend,you can explode/split it which will be much easier.
  • 为获得最佳实践,当 location 查询参数为空或不可用时,从所有位置获取结果。
  • 为了降低 API 调用的成本,您可以限制一次所选位置的数量。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。