landv/phalapi

接口，从简单开始！PhalApi简称π框架，一个轻量级PHP开源接口框架，专注于接口服务开发，支持HTTP/SOAP/RPC协议，拥有自动生成的在线文档、多种开发语言的客户端SDK包以及可重用的扩展类库，可用于快速搭建微服务、RESTful接口或Web Services。助你创造价值！

PhalApi 2.11.0 - 接口，从简单开始！

PhalApi Pro 专业版 - 智慧编程，让接口开发更有趣！

1、开发文档

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

2、在线示例

• 默认接口服务：http://demo.phalapi.net/?s=App.Site.Index
• 在线接口文档：http://demo.phalapi.net/docs.php
• 接口详情文档（以默认接口为例）：http://demo.phalapi.net/docs.php?service=App.Site.Index&detail=1&type=fold
• PhalApi创新项目-小白接口（免费、免开发、直接可用的的云端API）：https://www.okayapi.com/

3、快速安装

composer一键安装

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

$ composer create-project phalapi/phalapi

温馨提示：关于composer的使用，请参考Composer 中文网 / Packagist **全量镜像。

手动下载安装

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

$ composer update

4、使用

调用接口

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

• 默认接口：http://localhost/phalapi/public/?s=App.Site.Index

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

对应执行的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'],
        );
    }
}

接口请求后结果输出类似如下：

{
    "ret": 200,
    "data": {
        "title": "Hello PhalApi",
        "version": "2.4.2",
        "time": 1501079142
    },
    "msg": ""
}

运行效果，截图如下：

查看在线接口文档

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

• 在线接口文档：http://localhost/phalapi/public/docs.php

浏览效果类似如下：

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

6、子项目

• phalapi/kernal
• phalapi/notorm

7、还有问题，怎么办？

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