REST API HATEOAS分页冗余链接处理最佳实践咨询

REST API分页冗余链接最佳实践 #

按照HAL、JSON API等主流REST API规范的通用约定，你的场景下直接移除不存在的分页链接是最优方案，远优于保留冗余字段并设为当前页地址。

针对你提到的两个具体场景，处理方式如下：

• 分页结果仅1页时：仅保留self和last链接即可，二者href相同属于正常情况，不需要额外处理prev、next字段
• 处于最后一页时：直接移除next链接，同理处于第一页时也可直接移除prev链接

为什么不推荐保留冗余链接设为当前页地址 #

1. 不符合通用规范约定：主流REST分页规范的核心逻辑是「仅返回实际可访问的导航链接」，客户端只需要判断对应key是否存在，就能直接获知是否存在上/下页，判断逻辑极简
2. 避免客户端逻辑出错：如果保留冗余链接并设为当前页地址，客户端如果未做特殊校验，很容易出现重复拉取当前页、翻页死循环的问题，反而增加联调成本
3. 减少无效传输：冗余字段没有实际业务价值，移除后可以小幅降低响应体积，属于无成本优化

你给出的两个示例中，仅保留self和last的第二种实现是完全符合规范的写法。如果你们内部有强制要求必须返回四类链接的特殊规则，也建议把不存在的链接的href设为null，不要设为当前页地址。

内容的提问来源于stack exchange，提问作者Stefan Strandberg