![apic](http://cdn7.okayapi.com/yesyesapi_20190709223344_8aadbcfdbfa297a193012c0dada32a58.jpeg)
# [PhalApi开源接口框架 / PhalApi API Framework](https://www.phalapi.net/)
> 读音:派框架
[![Latest Stable Version](https://poser.pugx.org/phalapi/phalapi/v/stable)](https://packagist.org/packages/phalapi/phalapi)
[![Total Downloads](https://poser.pugx.org/phalapi/phalapi/downloads)](https://packagist.org/packages/phalapi/phalapi)
[![Latest Unstable Version](https://poser.pugx.org/phalapi/phalapi/v/unstable)](https://packagist.org/packages/phalapi/phalapi)
[![License](https://poser.pugx.org/phalapi/phalapi/license)](https://packagist.org/packages/phalapi/phalapi)
## Stargazers over time
[![Stargazers over time](https://starchart.cc/phalapi/phalapi.svg)](https://starchart.cc/phalapi/phalapi)
## 开发文档 / Documents
专为PHPer准备的优雅而详细的开发文档,请看:[PhalApi 2.x 开发文档](http://docs.phalapi.net/#/v2.0/)。
[PhalApi 2.x English Docs](http://docs-en.phalapi.net/#/v2.0/).
## 在线示例 / Demo
+ 默认接口服务:[http://demo.phalapi.net/?s=App.Site.Index](http://demo.phalapi.net/?s=App.Site.Index)
+ 在线接口文档:[http://demo.phalapi.net/docs.php](http://demo.phalapi.net/docs.php)
+ 接口详情文档(以默认接口为例):[http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold](http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold)
+ **PhalApi创新项目-小白接口**(免费、免开发、直接可用的的云端API):[https://www.yesapi.cn/](https://www.yesapi.cn/?f=github)
+ Default API:[http://demo.phalapi.net/?s=App.Site.Index](http://demo.phalapi.net/?s=App.Site.Index)
+ Online API List Document:[http://demo.phalapi.net/docs.php](http://demo.phalapi.net/docs.php)
+ Online API Detail Document:[http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold](http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold)
+ **Innovation project based on PhalApi-YesApi**:[https://www.yesapi.cn/](https://www.yesapi.cn/?f=github)
## 快速安装 / Install
### composer一键安装 / Install by composer
使用composer创建项目的命令,可实现一键安装。
One-click installation can be achieved by using the command of composer to create a project.
```bash
$ composer create-project phalapi/phalapi
```
> 温馨提示:关于composer的使用,请参考[Composer 中文网 / Packagist 中国全量镜像](http://www.phpcomposer.com/)。
### 手动下载安装 / Download and Install manually
或者,也可以进行手动安装。将此Git项目代码下载解压后,进行可选的composer更新,即:
Alternatively, manual installation is also possible. Download PhalApi Project master-2x branch Source code. After downloading and unzipping, perform an optional composer update:
```bash
$ composer update
```
## 部署 / Deployment
### Nginx配置 / Nginx Configuration
如果使用的是Nginx,可参考以下配置。
If you are using Nginx, you can refer to the following configuration.
```
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。
Point the root path of the visit to public folder. Save and reload nginx.
> 温馨提示:推荐将访问根路径指向/path/to/phalapi/public。
> Tips: It is recommended to point the root path of the visit to /path/to/phalapi/public.
### 数据库配置 / Database Configuration
如何使用的是MySQL数据库,参考修改```./config/dbs.php```数据库配置。
If you are using MySQL, please edit ```./config/dbs.php```.
```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目录添加写入权限。更多安装说明请参考文档[下载与安装](http://docs.phalapi.net/#/v2.0/download-and-setup)。
At last, add writeable permission to folder ```runtime```. For more detail about installation, refer to [Download and Installation](https://docs-en.phalapi.net/#/v2.0/download-and-setup).
## 使用 / Usage
### 调用接口 / API Request
在PhalApi,你可以通过service参数(短名字是s参数)指定需要调用的接口服务。例如,访问默认接口服务。
For PhalApi, the default communicate protocol is HTTP/HTTPS. According to the specific implementation of the API service, we could use GET or POST to request. By default, you can specify the ```service``` parameter or ```s``` for short when requesting. The default API service is ```App.Site.Index```.
+ 默认接口:[http://dev.phalapi.net/?s=App.Site.Index](http://dev.phalapi.net/?s=App.Site.Index)
+ Default API:[http://dev.phalapi.net/?s=App.Site.Index](http://dev.phalapi.net/?s=App.Site.Index)
对应执行的PHP代码在./src/app/Api/Site.php文件,源码片段如下:
The source PHP code of ```App.Site.Index``` API service is at ```./src/app/Api/Site.php``` file.
```php
<?php
namespace App\Api;
use PhalApi\Api;
/**
* 默认接口服务类
* @author: dogstar <chanzonghuang@gmail.com> 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'],
);
}
}
```
接口请求后结果输出类似如下:
API result as below after requesting:
```
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "2.4.2",
"time": 1501079142
},
"msg": ""
}
```
运行效果,截图如下:
Runtime
没有合适的资源?快使用搜索试试~ 我知道了~
PHP实例开发源码-PhalApi开源接口框架.zip
共1281个文件
dat:360个
php:308个
css:111个
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 135 浏览量
2022-11-21
11:26:02
上传
评论
收藏 5.26MB ZIP 举报
温馨提示
PHP实例开发源码—PhalApi开源接口框架.zip PHP实例开发源码—PhalApi开源接口框架.zip PHP实例开发源码—PhalApi开源接口框架.zip
资源推荐
资源详情
资源评论
收起资源包目录
PHP实例开发源码-PhalApi开源接口框架.zip (1281个子文件)
merge.bat 21B
CHANGELOG 1KB
PhalApiClient.cs 6KB
PhalApiClientResponse.cs 1KB
PhalApiClientParserJson.cs 593B
PhalApiClientFilter.cs 550B
PhalApiClientParser.cs 457B
App.Site.Index.cs 318B
semantic.css 809KB
semantic.min.css 614KB
button.css 110KB
button.min.css 88KB
icon.css 80KB
layui.css 71KB
grid.css 69KB
icon.min.css 65KB
grid.min.css 56KB
transition.css 46KB
menu.css 42KB
font-awesome.css 37KB
dropdown.css 35KB
transition.min.css 33KB
menu.min.css 31KB
font-awesome.min.css 30KB
form.css 27KB
label.css 26KB
dropdown.min.css 25KB
table.css 24KB
card.css 24KB
step.css 22KB
form.min.css 21KB
list.css 21KB
flag.css 21KB
rating.css 20KB
label.min.css 20KB
segment.css 19KB
step.min.css 19KB
flag.min.css 18KB
rating.min.css 18KB
table.min.css 18KB
card.min.css 17KB
layuimini.css 17KB
wangEditor.css 17KB
checkbox.css 16KB
popup.css 16KB
list.min.css 16KB
wangEditor.min.css 15KB
sidebar.css 15KB
layer.css 14KB
segment.min.css 13KB
header.css 12KB
checkbox.min.css 12KB
statistic.css 12KB
input.css 12KB
modal.css 12KB
popup.min.css 12KB
message.css 12KB
sidebar.min.css 10KB
progress.css 10KB
search.css 10KB
layui.mobile.css 10KB
statistic.min.css 9KB
item.css 9KB
zyupload-1.0.0.min.css 9KB
header.min.css 9KB
accordion.css 9KB
input.min.css 8KB
reset.css 8KB
message.min.css 8KB
modal.min.css 8KB
reveal.css 8KB
divider.css 8KB
laydate.css 7KB
progress.min.css 7KB
accordion.min.css 7KB
search.min.css 7KB
loader.css 7KB
divider.min.css 6KB
item.min.css 6KB
reveal.min.css 6KB
placeholder.css 6KB
feed.css 5KB
image.css 5KB
dimmer.css 5KB
comment.css 5KB
loader.min.css 5KB
placeholder.min.css 4KB
ad.css 4KB
site.css 4KB
image.min.css 4KB
shape.css 4KB
feed.min.css 3KB
dimmer.min.css 3KB
fonts.googleapis.com.css 3KB
embed.css 3KB
container.css 3KB
comment.min.css 3KB
reset.min.css 3KB
nag.css 3KB
shape.min.css 2KB
共 1281 条
- 1
- 2
- 3
- 4
- 5
- 6
- 13
资源评论
毕业_设计
- 粉丝: 1930
- 资源: 1万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- tcp/ip 实验,临时上传
- 艾默生PAC System3i PLC系列与其它设备TCP/IP通讯教程(不用其它网关,直接通讯,实用)
- 电力场景遥感数电杆塔检测数据集VOC+YOLO格式400张1类别.7z
- 九宫格数独游戏入门初级高级骨灰级完美.docx
- 网件 WG111 V3 网卡Windows10 /11 64位驱动
- 母亲节快乐的python编程代码四组.txt
- 母亲节快乐的python编程代码四组.zip
- 九宫格数独游戏入门初级高级骨灰级完美.zip
- 电力场景安全帽检测数据集VOC+YOLO格式295张2类别.7z
- MISC图片隐写MISC图片隐写MISC图片隐写MISC图片隐写MISC图片隐写.txt
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功