apic

PhalApi 2.4.2 - 接口,从简单开始!

Latest Stable Version Total Downloads Latest Unstable Version License

为了更好的接口开发体验,2019年,重新出发!

1、开发文档

专为PHPer准备的优雅而详细的开发文档,请看:PhalApi 2.x 开发文档

2、在线示例

3、快速安装

composer一键安装

使用composer创建项目的命令,可实现一键安装。

bash $ composer create-project phalapi/phalapi

温馨提示:关于composer的使用,请参考Composer 中文网 / Packagist 中国全量镜像

手动下载安装

或者,也可以进行手动安装。将此Git项目代码下载解压后,进行可选的composer更新,即:
bash $ composer update

4、使用

调用接口

在PhalApi,你可以通过service参数(短名字是s参数)指定需要调用的接口服务。例如,访问默认接口服务。

温馨提示:推荐将访问根路径指向/path/to/phalapi/public。

对应执行的PHP代码在./src/app/Api/Site.php文件,源码片段如下:
```php

/** * 默认接口服务类 * @author: dogstar 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'],
    );
}

} ```

接口请求后结果输出类似如下:
{ "ret": 200, "data": { "title": "Hello PhalApi", "version": "2.4.2", "time": 1501079142 }, "msg": "" }

运行效果,截图如下:

20170726223129_eecf3d78826c5841020364c852c35156

查看在线接口文档

PhalApi会根据你编写的接口的参数配置和代码注释,自动实时生成在线接口文档。在线接口文档链接为:

浏览效果类似如下:

_20190201113515

5、一张图告诉你如何使用PhalApi 2.x

phalapi-install

5、独家赞助商

此版本由(点击成为)独家赞助。

6、还有问题,怎么办?

如发现问题,或者任何问题,欢迎提交Issue到这里,或进入PhalApi开源社区
如果喜欢,请帮忙在Github码云给个Star,也可以对PhalApi进行捐赠哦 ^_^。