读音：派框架，官网：https://www.phalapi.net/
| 项目 | 说明 |
|---|---|
| 当前版本 | v8.0.0 |
| PHP 要求 | >= 8.0（已实测 8.0 与 8.4） |
| PHP 7.x | 不支持，composer install 会被拒绝 |
版本号说明：
v8.0.0中的 8 表示“支持 PHP 8”，不是 PhalAPI 的第 8 代版本。这是 2.x 的兼容性发布，接口写法与项目结构保持不变。
- PHP 必须升级到 8.0 及以上；
- 本仓库不再自带
vendor目录，拉取代码后必须执行composer install，否则无法运行； PhalApi\Crypt\McryptCrypt已由 mcrypt 改为 OpenSSL AES-256-CBC，历史密文不兼容（mcrypt 自 PHP 7.2 起已从 PHP 移除）。
完整步骤、破坏性变更与自查清单见：升级到 v8.0.0（PHP 8 支持）。
专为PHPer准备的优雅而详细的开发文档，基本都能在文档找到你要的答案，请看：PhalApi 8.x 开发文档。
- 在线接口文档：http://demo.phalapi.net/docs.php
- 接口详情文档（以默认接口为例）：http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold
- 默认接口服务：http://demo.phalapi.net/?s=App.Site.Index
使用composer创建项目的命令，可实现一键安装。
$ composer create-project phalapi/phalapi:^8.0
温馨提示：关于composer的使用，请参考Composer 中文网 / Packagist 中国全量镜像。
或者，也可以进行手动安装。将此Git项目代码下载解压后，必须执行composer安装依赖：
$ composer install
温馨提示：自 v8.0.0 起，仓库不再包含
vendor目录（此前会附带一份缺省的 vendor 安装包）。若跳过composer install，访问时会因找不到vendor/autoload.php而失败。
如果使用的是Nginx，可参考以下配置。
server { listen 80; server_name dev.phalapi.net; # 将根目录设置到public目录 root /path/to/phalapi/public; charset utf-8; location / { index index.php; } location ~ \.php$ { fastcgi_split_path_info ^(.+\.php)(/.+)$; # 根据当前环境，选择合适的通讯方式 # fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock; fastcgi_pass 127.0.0.1:9000; fastcgi_index index.php; include fastcgi_params; fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; } }
配置时需要将网站根目录设置到public目录，配置保存后重启nginx。
温馨提示：推荐将访问根路径指向/path/to/phalapi/public。
如何使用的是MySQL数据库，参考修改./config/dbs.php数据库配置。
return array( /** * DB数据库服务器集群 / database cluster */ 'servers' => array( 'db_master' => array( // 服务器标记 / database identify 'type' => 'mysql', // 数据库类型，暂时只支持：mysql, sqlserver / database type 'host' => '127.0.0.1', // 数据库域名 / database host 'name' => 'phalapi', // 数据库名字 / database name 'user' => 'root', // 数据库用户名 / database user 'password' => '', // 数据库密码 / database password 'port' => 3306, // 数据库端口 / database port 'charset' => 'UTF8', // 数据库字符集 / database charset 'pdo_attr_string' => false, // 数据库查询结果统一使用字符串，true是，false否 'driver_options' => array( // PDO初始化时的连接选项配置 // 若需要更多配置，请参考官方文档：https://www.php.net/manual/zh/pdo.constants.php ), ), ), // 更多代码省略…… );
最后，需要给runtime目录添加写入权限。更多安装说明请参考文档下载与安装。
在PhalApi，你可以通过service参数（短名字是s参数）指定需要调用的接口服务。例如，访问默认接口服务。
http://dev.phalapi.net/?s=App.Site.Index
接口请求后结果输出类似如下：
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "8.0.0",
"time": 1501079142
},
"msg": ""
}
对应执行的PHP代码在./src/app/Api/Site.php文件，源码片段如下：
<?php namespace App\Api; use PhalApi\Api; /** * 默认接口服务类 * @author: dogstar <[email protected]> 2014-10-04 */ class Site extends Api { public function getRules() { return array( 'index' => array( 'username' => array('name' => 'username', 'default' => 'PhalApi', 'desc' => '用户名'), ), ); } /** * 默认接口服务 * @desc 默认接口服务，当未指定接口服务时执行此接口服务 * @return string title 标题 * @return string content 内容 * @return string version 版本，格式：X.X.X * @return int time 当前时间戳 * @exception 400 非法请求，参数传递错误 */ public function index() { return array( 'title' => 'Hello ' . $this->username, 'version' => PHALAPI_VERSION, 'time' => $_SERVER['REQUEST_TIME'], ); } }
运行效果，截图如下：
PhalApi会根据你编写的接口的参数配置和代码注释，自动实时生成在线接口文档。在线接口文档链接为：
浏览效果类似如下：
接口文档详情页效果类似如下：
支持在线接口测试、请求示例说明、生成离线版HTML接口文档、实时更新。
./phalapi ├── README.md # 简介 ├── bin # 脚本目录 ├── config # 配置目录 │ ├── app.php # 应用配置 │ ├── dbs.php # 数据库配置 │ ├── di.php # 依赖服务配置 │ └── sys.php #系统配置 ├── data # 数据库 │ └── phalapi.sql # 数据库安装时的文件 ├── language # 翻译包 ├── public # 对外访问的目录 │ ├── docs # 离线生成的HTML接口文档 │ ├── docs.php # 在线版接口文档访问入口 │ ├── index.php │ ├── init.php # 全局初始化文件 │ ├── static # 静态资源 │ ├── uploads # 上传目录（需要有写入权限） │ └── phalapi_logo.png # logo图片 ├── runtime # 运行目录 │ ├── cache # 文件缓存 │ └── log # 文件日志 ├── sdk # SDK包 ├── src # 项目源代码，非常重要 │ ├── app # 接口源代码（遵循ADM模式） │ │ ├── Api # 放置接口源代码，相当于控制器层 │ │ ├── Common # 公共代码目录，放置工具等 │ │ ├── Domain # 领域业务层，负责业务逻辑和处理 │ │ ├── functions.php # 公共函数库 │ │ └── Model # 数据源层，负责数据持久化存储及操作 │ └── view # 页面模板目录（如接口文档） ├── tests # 单元测试 └── vendor # composer包，由 composer install 生成，不在版本库中
修改./public/init.php文件，可设置当前语言。
// 翻译语言包设定-简体中文 \PhalApi\SL('zh_cn'); // Setting language to English \PhalApi\SL('en');
- phalapi/kernal框架内核
- phalapi/notorm数据库包
- phalapi/authAuth权限扩展
- phalapi/cliCLI扩展类库
- phalapi/fast-routeFastRoute快速路由
- phalapi-aliyun-ossPhalApi-OSS阿里云OSS包
- phalapi/PHPMailer基于PHPMailer的邮件发送
- phalapi/qiniu七牛云存储接口调用
- phalapi/qrcodePhalApi 二维码扩展
- phalapi/pinyinPhalApi 8.x 拼音扩展
- phalapi/jwt基于PhalApi2的JWT拓展
- chenall/phalapi-weixin微信扩展
- phalapi/wechatmini微信小程序扩展
- phalapi/ding-com-bot钉钉企业内部webhook机器人扩展
- phalapi-pay支持微信支付和支付宝支付
温馨提示：以上扩展需要先通过composer安装再使用。更多扩展类库的使用和开发，请参考文档：PhalApi框架扩展类库。
温馨提示：应用插件和composer扩展的区别在于，应用插件颗粒度更大，功能更具体，可能不仅有数据库、接口、界面、还可能配合其他终端，并且不受composer的规范约束，是PhalApi自主发明和设计的开发方式。更多请参考：第三方应用插件开发教程。
温馨提示：以上产品均使用了PhalApi开源框架，并为官方自主研发的产品，欢迎个人/团队/企业使用。
如发现问题，或者任何问题，欢迎提交Issue到这里。
如果喜欢，请帮忙在Github或码云或GitCode给个Star，也可以对PhalApi进行捐赠哦 ^_^。
Apache 2.0，Apache Licence是著名的非盈利开源组织Apache采用的协议。该协议和BSD类似，同样鼓励代码共享和尊重原作者的著作权，同样允许代码修改，再发布（作为开源或商业软件）。
由 广州果创网络科技有限公司 长期维护升级。