前言

PhalApi是什么?

PhalApi,简称:π框架,是一个国内开源的PHP轻量级接口开发框架,专注于接口服务开发,支持HTTP、SOAP、RPC协议,可用于快速搭建微服务、RESTful接口或Web Services。

为什么写这本书?

在PhalApi官网上,已经有相关的技术开发文档,但由于前期缺少明确的规划,文档难免显得凌乱。为了更好让开发同学查阅学习、快速入门项目开发,这里特此重新整理此书,系统讲解PhalApi的使用,为开发同学提供更连贯的学习参考。同时又保留原来已有的文档,不致于404。

所用版本

本书统一约定使用PhalApi 1.4.0 版本。由于框架更新较快,这里尽量讲述主要重点功能和特性。

目标读者

  • 初学者:希望通过学习PhalApi框架的基础与核心内容,从而进行接口项目开发
  • 大工匠:希望结合TDD、重构、设计模式等,精益求精,快速进行项目迭代,尤其是研发创业项目
  • 探险者:对PhalApi进行定制和研发专属扩展类库,打造成公司内部产品簇的接口应用框架
  • 架构师:专注于框架的设计、解读高层思想和了解开源社区的发展历程

本书约定

示例源代码

本书示例的源代码,可在下面的Github项目上获得。

https://github.com/phalapi/meet

其中对于保存在此Github项目中的代码,会以vim编辑的文件路径注释开头,类似下面这样。第一行注释表明,当前代码保存在./Shop/Api/Welcome.php文件中,并且省略号表示省略的代码片段。

// $ vim ./Shop/Api/Welcome.php     
class Api_Welcome extends PhalApi_Api {
... ...

而对于未存放在此项目的演示代码,则不会有此注释,例如这样:

$rs = DI()->notorm->user->where('id', $userId)->update($data);
... ...

命令操作

若无特殊说明,执行命令的所在目录是当前项目的根路径,例如前面的:

$ vim ./Shop/Api/Welcome.php

表示,当前位置是/path/to/PhalApi,且符号“$”表示当前为普通用户。若是root用户时,则以“#”开头。

温馨提示

对于需要注意的事项,会使用类似以下的温馨提示进行说明。

温馨提示:这是温馨提示说明。

本书所使用的环境

  • PHP 5.3.10
  • Nginx 1.1.19
  • PhalApi 1.4.0
  • Ubuntu 12.04(64位)

Fork me on GitHub