GET List 和 GET Paginated 的 REST 命名约定答案

【问题标题】：REST Naming convention for GET List and GET PaginatedGET List 和 GET Paginated 的 REST 命名约定
【发布时间】：2021-03-11 16:26:35
【问题描述】：

我必须为同一个实体创建两个端点，一个返回实体列表，第二个返回分页结果（包含列表和 totalPages、pageNumber、totalPerPage 等）。

点赞：

GET /entity?filter1=x&filter2=y 返回分页结果

GET /entity?param=x&param=y 返回一个列表

问题：

我不能使用相同的路径来做到这一点。那么它的命名约定是什么？

类似：“GET /entity”和“GET /entity/page”？

【问题讨论】：

【解决方案1】：

REST 不关心您为资源标识符使用的拼写约定。您可以使用您喜欢的任何拼写 - 最好与您的当地惯例保持一致，并且您的某些人类用户（文档编写者、阅读访问日志的操作员等）首选所选择的拼写。

采纳您的领域专家的观点可能会有所帮助 - 这两个不同的报告是否具有不同的名称？它们被不同的消费者使用吗？具有不同代号的项目？发布日期不同？不同版本的架构？

设计资源标识符的一个常见问题：没有清楚地了解实际资源（文档）本身是什么。

如果您无法提出任何明智的建议，请退回到您理解的差异。

GET /entity/list?...
GET /entity/page?...

再次，也很好。

【讨论】：