什么是π框架?
全称Phalapi,是一个PHP轻量级开源接口框架,以下是他的优点:
免费:最好的往往是免费的; 不断更新:15年发布,到现在不断的更新和完善,现已达到2.X版本; 简单易学:新版本引入了命名空间和composer统一管理依赖包,相对有thinkphp5框架学习基础的人,很快就可以从入门到实战了; 提供很多接口服务:可用于快速搭建微服务、RESTful接口或Web Services;
2.X版本
使用了composer统一管理依赖包 引入了命名空间 遵循PSR-4规范
适用场景
为移动App(包括iOS、iPad、Android、Windowns Phone等终端)提供接口服务; 用于搭建接口平台系统,提供聚合类接口服务,供其他后端系统接入使用; 为前后端分离的H5混合页面应用,提供Ajax异步接口;
入门
前面说了,phalapi框架新版本2.x与旧版本1.x传统的设计理念的不同,学过thinkphp5的人,半天就可以入门π框架,但如果没学过thinkphp5的人岂不是一脸懵逼?不用担心,下面小编带你简单的过一下学习的流程。
下载
从官网【https://www.phalapi.net/】上下载2.x版本的π框架,放到你wamp集成环境下可以访问位置(当然你单独用Nginx或Apache服务也行,集成环境只是图个方便),还有最好用火狐浏览器显示接口返回的json数据,(它会让数据结构更加清晰,方便你学习),最后建议一个编辑器那就是PhpStorm。
访问默认接口
安装完相应工具,你离成功就不远啦!在火狐浏览器输入:http://localhost/phalapi/public/(根据个人根目录的不同在访问),效果如下:
代码语言:javascript复制ps:(如未显示全,可右滑)
与我不同的是,你没显示debug数据,可在config/sys.php修改debug为true
那么为什么会有数据显示呢?我们明明就没有写接口呀?因为这个默认接口服务,也可以说是example;
红框:入口文件 黄框:默认访问api类Site 篮框:默认访问接口服务
项目源代码放置在上图中的src文件,里面各个命名空间对应一个子目录,默认命名空间是app,里面主要有Api、Domain、Model这三个目录以及存放函数的functions.php文件。 当需要新增一个接口时,先要在Api层添加一个新的接口文件。例如对于Hello World示例,可以使用你喜欢的编辑器创建一个./src/app/Api/Hello.php文件,并在里面放置以下代码。(如图)
代码语言:javascript复制// 文件 ./src/app/Api/Hello.php
<?php
namespace AppApi;
use PhalApiApi;
class Hello extends Api {
public function world() {
return array('title' => 'Hello World!');
}
}
访问一个接口
通常情况下,建议可访问的根路径设为/path/to/PhalApi2/public。若未设置,此时接口访问的URL格式为:接口域名/public/?s=Namespace.Class.Action。其中,s参数用于指定待请求的接口服务,由三部分组成
组成部分 | 是否必须 | 默认值 | 说明 |
---|---|---|---|
Namespace | 可选 | APP | Api命名空间前缀 |
Class | 必须 | 无 | 待请求的接口类名 |
Action | 必须 | 无 | 待请求的接口类方法名 |
PS:(如未显示全,可右滑)
Nmaespace的多级命名空间时用下划线分割
Class通常首字母大写
Action通常首字母大写。若Class和Action均未指定时,默认为Site.Index
效果
代码语言:javascript复制PS:当响应成功时,http状态码应该为200,我在源代码里修改响应类ret为1
恭喜!你已顺便完成PhalApi 2.x 简单的接口开发了!
在这里,小编对代码进行了部分注释,希望对大家的学习有所帮助,也希望有问题加我微信(wzc88czw)交流学习心得。