0

0

Pwoli.js 中实现分页信息返回的完整配置指南

霞舞

霞舞

发布时间:2026-03-14 10:12:29

|

426人浏览过

|

来源于php中文网

原创

Pwoli.js 中实现分页信息返回的完整配置指南

在 Pwoli.js 中,API 默认返回纯数据数组,不包含分页元信息;通过启用集合信封(collection envelope)机制,可将数据包裹在指定键下,并自动注入 current_page、total_count、total_pages 等分页元数据到响应体中。

在 pwoli.js 中,api 默认返回纯数据数组,不包含分页元信息;通过启用集合信封(collection envelope)机制,可将数据包裹在指定键下,并自动注入 `current_page`、`total_count`、`total_pages` 等分页元数据到响应体中。

Pwoli.js 默认采用“扁平化” JSON 响应设计——即直接返回资源数组(如 [{ "id": 1, "title": "Company - 1" }, ...]),虽简洁但缺失分页上下文。若需在前端实现带页码跳转、总条数显示或禁用/启用「下一页」按钮等交互,必须让 API 同时返回数据 + 分页元信息(metadata)。

解决方案是启用 collection envelope(集合信封)功能。该机制会将原始数据数组封装进一个具名对象,并在同一层级注入标准化分页字段。配置方式极其简洁,只需在调用 Pwoli.respond(...) 前设置序列化器的 collectionEnvelope 属性:

// 在控制器逻辑中(例如 index action 内)
Pwoli.serializer.collectionEnvelope = 'companies';

// 此后调用 respond 即生效
Pwoli.respond(companies); // ← companies 是查询得到的 Model 实例数组

配置生效后,API 响应结构将从:

[
  { "id": 1, "title": "Company - 1", "myGetter": "EVENT - 3" },
  { "id": 2, "title": "Company - 2", "myGetter": "EVENT - 5" }
]

变为标准的带元数据封装格式:

Otter.ai
Otter.ai

一个自动的会议记录和笔记工具,会议内容生成和实时转录

下载
{
  "companies": [
    { "id": 1, "title": "Company - 1", "myGetter": "EVENT - 3" },
    { "id": 2, "title": "Company - 2", "myGetter": "EVENT - 5" }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 20,
    "total_count": 47,
    "total_pages": 3
  }
}

关键说明

  • collectionEnvelope = 'companies' 中的字符串 'companies' 即为数据主键名,建议与资源复数形式一致;
  • 分页元信息统一挂载在顶层 pagination 对象下,字段命名语义清晰、符合 RESTful 惯例;
  • 所有分页参数(如 page、per-page)由 Pwoli 自动从请求 Query 解析并应用,无需手动计算;
  • 若需自定义 pagination 键名(如改为 meta),可通过继承并重写 Pwoli.serializer.getPaginationData() 方法实现。

? 最佳实践建议

  • 在 BaseController 中统一设置 Pwoli.serializer.collectionEnvelope,避免各 action 重复声明;
  • 前端 Axios/Fetch 接收响应后,应优先校验 response.data.pagination 是否存在,再进行 UI 渲染;
  • 若某接口无需分页(如获取单条详情),请在该 action 中临时清空信封:Pwoli.serializer.collectionEnvelope = null,确保响应结构一致性。

通过这一配置,你即可在不修改业务逻辑的前提下,快速获得生产就绪的分页能力——数据与元信息解耦清晰、结构可预测、前端消费零成本。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

179

2025.11.26

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

457

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

549

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

337

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

82

2025.09.10

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

254

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1089

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

26

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 10.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号