← 中文资源

简体中文版本

API 分页标准化工作流

在全 API 选定一种分页风格、定义游标或页码语义、记录限额与错误,并逐步迁移不一致的接口。

阅读英文原文

概述

不同接口各自分页会让客户端为每个列表单独实现。选定一种主风格与默认及最大页大小、定义响应形状与结束信号、规范无效游标错误,并以弃用方式逐步迁移旧接口,可让客户端只需一套迭代逻辑。

关键步骤

  1. 选定主风格及默认与最大页大小。
  2. 定义响应形状、下一游标语义与结束信号。
  3. 统一无效或过期游标的错误响应。
  4. 以弃用方式逐步迁移不一致接口。

验证

  • 新接口遵循约定。
  • 限额被强制执行。
  • 无效游标错误一致。
  • 待迁移接口有跟踪。

决策点

信息流与大数据宜用游标,需跳页时用页码;超限页应返回错误而非静默截断,后者会掩盖客户端缺陷。

适用范围

本条目围绕「API 分页标准化工作流」给出可复制的步骤、验证方式与常见问题,适合需要按此流程落地的工程团队。执行时请结合自身上下文调整命令与阈值,并在变更前后留存证据,便于后续复核与回滚。

建议在正式环境落地前先在预发或隔离环境演练一遍,把关键观测指标与负责人一并记录,确保出现异常时能快速定位并恢复。

{
  "data": [ /* items */ ],
  "meta": { "nextCursor": "eyJpZCI6MTAwfQ", "limit": 20 }
}