PhalApi开源接口框架,简称π框架,一个轻量级PHP开源接口框架,专注于接口服务开发。接口,从简单开始!
读音:派框架,官网:https://www.phalapi.net/
专为PHPer准备的优雅而详细的开发文档,基本都能在文档找到你要的答案,请看:PhalApi 2.x 开发文档。
使用composer创建项目的命令,可实现一键安装。
$ composer create-project phalapi/phalapi温馨提示:关于composer的使用,请参考Composer 中文网 / Packagist 中国全量镜像。
或者,也可以进行手动安装。将此Git项目代码下载解压后,进行可选的composer更新,即:
$ composer update如果使用的是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数据库配置。
…最后,需要给runtime目录添加写入权限。更多安装说明请参考文档下载与安装。
在PhalApi,你可以通过service参数(短名字是s参数)指定需要调用的接口服务。例如,访问默认接口服务。
http://dev.phalapi.net/?s=App.Site.Index接口请求后结果输出类似如下:
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "2.4.2",
"time": 1501079142
},
"msg": ""
}对应执行的PHP代码在./src/app/Api/Site.php文件,源码片段如下:
…运行效果,截图如下:
PhalApi会根据你编写的接口的参数配置和代码注释,自动实时生成在线接口文档。在线接口文档链接为:
浏览效果类似如下:
接口文档详情页效果类似如下:
支持在线接口测试、请求示例说明、生成离线版HTML接口文档、实时更新。
…修改./public/init.php文件,可设置当前语言。
// 翻译语言包设定-简体中文
\PhalApi\SL('zh_cn');
// Setting language to English
\PhalApi\SL('en');温馨提示:以上扩展需要先通过composer安装再使用。更多扩展类库的使用和开发,请参考文档:PhalApi框架扩展类库。
温馨提示:应用插件和composer扩展的区别在于,应用插件颗粒度更大,功能更具体,可能不仅有数据库、接口、界面、还可能配合其他终端,并且不受composer的规范约束,是PhalApi自主发明和设计的开发方式。更多请参考:第三方应用插件开发教程。
温馨提示:以上产品均使用了PhalApi开源框架,并为官方自主研发的产品,欢迎个人/团队/企业使用。
如发现问题,或者任何问题,欢迎提交Issue到这里。
如果喜欢,请帮忙在Github或码云或GitCode给个Star,也可以对PhalApi进行捐赠哦 ^_^。
Apache 2.0,Apache Licence是著名的非盈利开源组织Apache采用的协议。该协议和BSD类似,同样鼓励代码共享和尊重原作者的著作权,同样允许代码修改,再发布(作为开源或商业软件)。
由 广州果创网络科技有限公司 长期维护升级。
暂无开放 Issues,或尚未同步最近议题。