PhalApi: PHP轻量级的后台接口开发框架，专注于后台接口的快速开发。在移动互联网时代的这十年，希望此框架能对各接口开发有实际的帮助，欢迎使用！我们致力于将PhalApi维护成像恒星一样：不断更新，保持生气；为接口负责，为开源负责！让后台接口开发更简单！

#PhalApi - 轻量级PHP后台接口开发框架 - V1.1.1

###PhalApi是一个轻量级PHP后台接口开发框架，目的是让接口开发更简单。

如果您决定采用此框架进行接口项目开发，请邮件（chanzonghuang@gmail.com）知会我一下，谢谢 ^_^

在此借一行文字的空间，感谢 开源中国 这么好的分享平台，同时也感谢您花费宝贵的时间来阅读此文档，在开源的路上，您每一次真心的关注和肯定都是我们前进的最大动力！谢谢！

#背景过去十年，是互联网时代；如今的十年，是移动时代。

在iOS、Android、Windows Phone、PC版、Web版等各种终端和各种垂直应用不停更新迭代的大背景下，显然很是需要一组乃至一系列稳定的后台接口支撑。接口，是如此重要，正如Jaroslav Tulach在《软件框架设计的艺术》一书中说的：

API就如同恒星，一旦出现，便与我们永恒共存。

所以，这里希望通过提供一个快速可用的后台接口开发框架，可以：

一来，支撑轻量级项目后台接口的快速开发；
二来，阐明如何进行接口开发、设计和维护，以很好支持海量访问、大数据、向前向后兼容等；
三来，顺便分享一些好的思想、技巧和有用的工具、最佳实践。

如果您有接口项目开发的需要，又刚好需要一个PHP接口框架，欢迎使用！我们也争取致力于将我们的PhalApi维护成像恒星一样：

不断更新，保持生气；为接口负责，为开源负责！

#安装

请从release分支拉取稳定的代码
推荐在Linux服务器上进行开发
建议PHP >= 5.3.3

将代码下载解压到服务器后即可，然后把根目录设置为Public。如nginx下：

root   /.../PhalApi/Public;

为验证是否安装成功，可以访问默认接口服务，如：http://localhost/PhalApi/demo/，正常时会返回类如：

{
    "ret": 200,
    "data": {
        "title": "Default Api",
        "content": "PHPer您好，欢迎使用PhalApi！",
        "version": "1.1.0",
        "time": 1422779027
    },
    "msg": ""
}

#在线体验

//默认的接口服务
http://phalapi.oschina.mopaas.com/Public/demo/

//带参数的示例接口
http://phalapi.oschina.mopaas.com/Public/demo/?service=Default.Index&username=oschina

//故意请求一个非法的服务
http://phalapi.oschina.mopaas.com/Public/demo/?service=Demo.None
{
    "ret": 400,
    "data": [],
    "msg": "非法请求：服务Demo.None不存在"
}

#文档 ###后台接口开发就是如此简单，Write the code, enjoy yourself !


前言
    首页

基础入门

上篇
    [1.1] 快速入门: 接口开发示例(源码+图文)
    [1.2] 参数规则：接口参数规则配置
    [1.3] 统一的接口请求方式：?sevice=XXX.XXX 
    [1.4] 统一的返回格式和结构：Ret Data Msg
    ...

下篇
    [1.10] 类的自动加载：遵循PEAR包的全名规范
    [1.11] 签名验证：自定义签名规则
    [1.12] 请求和响应：GET和POST两者皆可得及超越JSON格式返回
    [1.13] 缓存策略：更灵活地可配置化的多级缓存
    ...

高级专题
    [2.1] 核心思想：Di依赖注入 让资源更可控
    [2.2] 海量数据：可配置的分库分表
    [2.3] 接口调试：在线sql语句查看与性能优化
    ...

项目实践
    [3.1] 开发实战1：微信服务号开发
    [3.2] 开发实战2：模拟优酷开放平台接口项目开发
    [3.3] 开发实战3：模拟腾讯开放平台接口项目开发
    ...

其他
    杂谈：扯一些phal Api的前世和今生

文档整体情况如上，目前文档还在 努力编写中 。如需要 查看最新的文档 ，请访问：PhaApi Wiki

#官网官网还在努力开发中，感兴趣的同学，可以访问：www.phalapi.net

#[酷！]接口参数在线查询为了方便客户端查看最新的接口参数，特别提供此在线工具，根据接口代码实时生成接口参数报表，完全不需要后台开发编写维护额外的文档。我觉得，这很符合敏捷开发之道。

//接口参数在线查询工具链接
http://phalapi.oschina.mopaas.com/Public/demo/checkApiParams.php

如：http://phalapi.oschina.mopaas.com/Public/demo/checkApiParams.php ，访问效果如下：

mahua 因此，接口所需要的参数，对于接口开发人员，也只是简单配置一下参数规则，便可以轻松获取。

#[赞！]接口单元测试不能被测试的代码，不是好代码。在使用此框架进行接口开发时，我们强烈建议使用测试驱动开发，以便于不断积累形成接口测试体系，保证接口向前向后兼容。
如下，是对接口 /?service=User.GetBaseInfo&userId=1 进行单元测试时，按： 构造-操作-检验（BUILD-OPERATE-CHECK）模式 ，即：

    /**
     * @group testGetBaseInfo
     */ 
    public function testGetBaseInfo()
    {
        $str = 'service=User.GetBaseInfo&userId=1';
        parse_str($str, $params);

        DI()->request = new PhalApi_Request($params);

        $api = new Api_User(); 
        //自己进行初始化
        $api->init();
        $rs = $api->getBaseInfo();

        $this->assertNotEmpty($rs);
        $this->assertArrayHasKey('code', $rs);
        $this->assertArrayHasKey('msg', $rs);
        $this->assertArrayHasKey('info', $rs);

        $this->assertEquals(0, $rs['code']);

        $this->assertEquals('dogstar', $rs['info']['name']);
        $this->assertEquals('oschina', $rs['info']['from']);
    }

运行效果：

核心框架的代码单元测试覆盖率（截于2015-02-05）：
单元测试代码覆盖率
更多请参考：最佳开发实践：自动化单元测试 - PHP #主要目录结构

.
│
├── PhalApi         //PhalApi框架，后期可以整包升级
│
│
├── Public          //对外访问目录，建议隐藏PHP实现
│   └── demo        //Demo服务访问入口
│
│
├── Config          //项目接口公共配置，主要有：app.php, sys.php, dbs.php
├── Data            //项目接口公共数据
├── Language        //项目接口公共翻译
├── Runtime         //项目接口运行文件目录，用于存放日记，可软链到别的区
│
│
└── Demo            //应用接口服务，名称自取，可多组
    ├── Api             //接口响应层
    ├── Domain          //接口领域层
    ├── Model           //接口持久层
    └── Tests           //接口单元测试

#更新日记以下更新日记，主要是为了说明，我们一直在努力更新和维护。

1、代码小酌，重构代码、整理注释，让代码更明了，更统一，更达意；
2、添加工具类，其中有：IP地址获取、随机字符串生成；

###2015-02-11

1、官网发布上线：http://112.74.107.125/，域名已申请，待绑定：www.phalapi.net；

###2015-02-09

1、将原来限制于JSON格式的返回调整成更灵活的组件形式，以便支持JSON、JSONP和测试环境下的格式返回，和扩展项目开发所需要的格式；
2、接口基类的初始化函数PhalApi_Api::initialize()精简名字为init()；
3、全部核心的代码注释中的author追加个人邮箱地址；
4、单元测试完善补充和文档整理；

###2015-02-07

1、完善接口调试下SQL的输出、示例和单元测试，以及WIKI文档的编写；
2、日记接口文档的编写；
3、合并master到release，并将版本号更新到1.1.1；

###2015-02-04

1、根据质量分析后Sonar提供的报告，整理代码，包括统一的注释、对齐、代码风格、命名规则等；
2、默认服务的注册，有：DI()->request、DI()->response；

###2015-02-02 版本1.1.0 一个全新的开始！

此版本在原来的基础上进行了大量的重构和更多的规范统一，主要有：
1、分离框架代码和项目代码，便于以后框架升级；
2、统一全部的入口文件，以便不同的版本、终端、入口和测试环境使用，并隐藏PHP语言实现；
3、框架代码统一从原来的Core_改名为PhalApi_，并且把PhalApi_DI::one()统一为快速函数的写法：DI()；
4、重新界定应用项目的代码目录结构，以包的形式快速开发；
5、全部文档相应更新；
//注意！此版本不兼容旧的写法，如有问题，请与我联系。

###2015-02-01

1、正常时，ret返回调整为：200，原来为0；
2、异常统一简化为两大类：客户端非法请求400、服务端运行错误500；
3、日记文件写入重构，并将权限更改为777，以便不同场合下日记写入时的permission denied；
4、单元测试整理；

###2015-01-31

1、参数规则的解析，移除不必要的固定类型，以及addslashes转换，单元测试整理；
2、参数规则文档编写：http://my.oschina.net/u/256338/blog/372947

###2015-01-29

1、examples代码重新整理，及入门文档同步更新；
2、入口文件的调整；

###2015-01-28

1、补充入门开发示例的文档，及相关的测试代码和产品代码，主要是examples；
2、提供接口参数在线查询工具；

###2015-01-24

1、PhalApi开源；

wufeiafei / PhalApi

简介

发行版

贡献者

近期动态

wufeiafei / PhalApi .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

wufeiafei / PhalApi