Agent Skills
返回列表
PhalApi PHP 接口框架

PhalApi PHP 接口框架

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_ef796dd2/phalapi。

技能介绍

要解决什么问题

PHP 项目里做 HTTP/SOAP/RPC 接口时,常见痛点是:分层边界模糊(Controller 里直接写 SQL)、参数校验重复、接口文档与代码脱节。PhalApi(π 框架)用 ADM(Api-Domain-Model)固定调用方向,并内置参数规则与在线文档生成;本技能把官方开发路径整理成可检索的操作说明,方便在 Agent 对话里按层写代码、查配置。

技能如何帮你落地

  • ADM 分层:Api 只做入参校验与调度;Domain 承载业务规则,可调用同级 Domain 与 Model;Model 负责 NotORM 与缓存。禁止 Api→Model、Domain→Api、Model→Domain,跨层报错时应对照这张表排查。
  • 参数体系:系统参数(service/s)、应用级 apiCommonRules、接口级 getRules();支持 string/int/enum/file/callable 等类型及完整校验配置。
  • 数据与基础设施:config/dbs.php 配置库表与分表;通过 $di->notorm、$di->cache、$di->logger、$di->filter 使用数据库、缓存、日志与 MD5 签名(SimpleMD5Filter + 白名单)。
  • 文档与测试:注释规范驱动 /docs.php 在线文档;phalapi-buildtest 与 TestRunner 支持 BUILD-OPERATE-CHECK 式单测。
  • 进阶能力:2.13.0+ 的 DataApi 通用 CRUD、Gearman 队列、多库/分表、sys.debug / enable_sql_log 等 SQL 调试开关。

适用边界与注意点

技能面向 PhalApi v2 风格项目(PSR-4、src/app/{Api,Domain,Model}),不是通用 Laravel/Symfony 教程。NotORM 实例带状态:事务或连续查询宜通过 $this->getORM() 取新实例;全表删除需带 WHERE。生产环境注意日志脱敏、签名密钥一致与 API_MODE(dev/test/prod)对应的环境配置。更完整的 API 以 官方文档 为准。

使用场景

  • 在 PhalApi 项目里新增用户相关 HTTP 接口,需要按 Api→Domain→Model 写 `getRules()` 与业务类,避免 Controller 直连数据库。
  • 线上接口返回参数校验错误码,需要对照三级参数规则(系统/应用/接口)和 `callable` 回调,定位是配置还是类型问题。
  • 管理后台要对多张表做增删改查,但不想每张表手写 Api,计划用 2.13.0+ 的 `DataApi`/`DataModel` 继承方式快速落地。
  • 对接 App 客户端需开启 MD5 签名与白名单,要在 `config/di.php` 配置 `SimpleMD5Filter` 并核对参数字典序拼接规则。

适合人员

  • 维护公司现有 PhalApi v2 微服务、需要在 `src/app/Api` 与 Domain 间严格分层的 PHP 后端工程师
  • 负责接口安全与联调、要配置过滤器白名单并排查 `sign` 校验失败的后端或全栈开发
  • 正在做分库分表或读写分离、需要编辑 `config/dbs.php` 与 Model 里 `getORM($id)` 路由逻辑的数据库相关开发
  • 希望接口注释能自动生成 `/docs.php` 在线文档,并配合 `phalapi-buildtest` 写 BUILD-OPERATE-CHECK 单测的接口负责人