ThinkPHP分页api返回构建分页json返回格式-ThinkPHP-PHP中文网

thinkphp 6 的 paginate() 默认返回 paginator 对象而非标准 json，需调用 toarray() 转换为含 data、current_page、last_page、per_page、total 等字段的数组，再封装为 json 响应，才能被前端分页组件正确解析。

thinkphp分页api返回构建分页json返回格式

ThinkPHP 6 的 `paginate()` 默认不返回 JSON 分页结构

直接调用 paginate() 返回的是 think\Paginator 对象，不是标准 JSON；前端拿不到 last_page、per_page 等字段，会报错或渲染失败。

常见错误现象：TypeError: Cannot read property 'data' of undefined（因为没解构出 data 字段），或分页控件显示总页数为 NaN。

必须手动调用 toArray() 或使用 render() 配合自定义输出
paginate() 返回对象本身不可直接 json_encode()，它内部有闭包和资源句柄
TP6.1+ 推荐用 simplePaginate() + 手动构造更轻量，但丢失总记录数

用 `toArray()` 提取分页数据并重组成标准 JSON 格式

这是最稳妥、兼容性最好的方式，保留总条数、当前页、每页数量、总页数等关键字段，适配主流前端分页组件（如 Element Plus、Ant Design Vue）。

实操建议：

Json Schema Toolkit

使用 JSON Schema 验证 JSON 数据，从示例 JSON 生成 schema，并将其转换为 TypeScript 接口、Python 数据类或 Markdown 文档。

下载

在控制器中先调用 $list = User::where(...)->paginate(15)
再用 $list->toArray() 得到数组，它已包含 data、current_page、last_page、per_page、total 等键
注意：last_page 是整数，current_page 和 per_page 也是数字，无需额外类型转换
若需兼容旧版前端（比如要求字段叫 page_no 而非 current_page），就用 array_merge() 重映射

示例代码片段：

$result = $list->toArray();
return json([
    'code' => 0,
    'msg'  => 'success',
    'data' => [
        'list'       => $result['data'],
        'page_no'    => $result['current_page'],
        'page_size'  => $result['per_page'],
        'total'      => $result['total'],
        'total_page' => $result['last_page']
    ]
]);

避免踩坑：`render()` 不要直接塞进 JSON，`app_debug` 开启时会暴露模板路径

有人误把 $list->render()（生成 HTML 分页条）当成分页元数据，塞进 JSON 返回——这会导致响应体混入 HTML 字符串，前端解析失败；更隐蔽的问题是：当 app_debug = true 时，render() 可能输出带调试信息的 HTML，含 vendor/topthink/think-orm/src/paginator/Bootstrap.php 这类路径，泄露项目结构。