##1.23.1 请求
把我们后台的API想象成一个函数,那么请求的参数就是我们的参数列表;而接口响应的数据则对应函数返回的结果。
对于请求,正如前面所看到的,我们可以使用$_GET,也可以使用$_POST,也可以两者都使用,还可以在测试时自己指定模拟的请求数据包。
或者,在实际项目开发中,我们还需要根据自身的需求,跟我们自己的客户端作一些约定。如通常地,我们会要求客户端 **service参数必须用GET方式** ,以便服务器返回500时定位接口服务位置。对此,简单的我们把$_POST['service']去掉即可,如在入口文件前面添加:
```javascript
unset($_POST['service']); //只接收GET方式的service参数
```
###(1)在index.php入口处指定数据源
很多时间,不同的项目对数据接收有不同的需求。如简单地,如果客户端是通过JSON后再传递的话,我们可以这样在入口处进行代码调整:
```javascript
//vim ./index.php
$HTTP_RAW_POST_DATA = isset($GLOBALS['HTTP_RAW_POST_DATA']) ? $GLOBALS['HTTP_RAW_POST_DATA'] : "{}";
DI()->request = new PhalApi_Request(array_merge($_GET,json_decode($HTTP_RAW_POST_DATA, true)));
```
###(2)单元测试时指定数据源
在进行单元测试时,我们需要模拟接口的请求动作,也需要提供接口参数。这时的参数的指定更为灵活。可通过以下代码来实现,即:
```javascript
//数据源
$data = array(...);
DI()->request = new PhalApi_Request($data);
```
或者使用PhalApi封装的测试类来快速模拟调用接口:
```
public function testIndexByRunner()
{
//Step 1. 构建请求URL
$url = 'service=Default.Index&username=dogstar';
$params = array();
//Step 2. 执行请求
$rs = PhalApi_Helper_TestRunner::go($url, $params);
```
###(3)接口数据的加密传送
有时,出于安全性的考虑,项目需要对请求的接口参数进行对称加密传送。这时可以通过重载PhalApi_Request::genData()来轻松实现。
假设,我们现在需要把全部的参数base64编码序列化后通过_POST['data']来传递,则相应的解析代码如下。
第一步,先定义自己的扩展请求类,在里面完成对称解析的动作:
```
<?php
class Common_Request extends PhalApi_Request {
public function genData($data) {
if (!isset($data) || !is_array($data)) {
return $_POST; //改成只接收POST
}
$postData = isset($data['data']) ? base64_decode($data['data']) : array();
}
}
```
第二步,在index.php入口文件中重新注册请求类(即添加以下代码):
```
//重新注册request
DI()->request = 'Common_Request';
```
然后,就可以轻松实现了接口参数的对称加密传送。
至此,你也许已经发现:指定数据源和对称加密是可以结合来使用的。
##1.23.2 响应
当前默认使用JSON的格式返回,但项目需要其他返回格式也是可以的。只需要实现PhalApi_Response抽象中的formatResult($result)格式化返回结果,然后也是重新注册DI()->response服务即可。如:
###(1)JSONP的返回
在H5页面中,我们可能会需要用到JSONP的返回,所以这里默认提供了这种格式的支持。
在入口文件中,添加:
```javascript
//支持JsonP的返回
if (!empty($_GET['callback'])) {
DI()->response = new PhalApi_Response_JsonP($_GET['callback']);
}
```
在接口访问时再带上&callback=XXX参数即可。
这里在创建响应服务时,可以看到是用了回调函数的名字进行初始化。考虑到会存在XSS(跨站脚本攻击),对回调函数要进行相应的过滤,可以用黑名单或者白名单的方式。黑名单方式暂时还没提供,白名单相对简单但需要项目自己实现,如:
```javascript
class Common_JsonP extends PhalApi_Response_JsonP {
protected function clearXss($callback) {
return in_array($callback, array('fun1', 'func2', 'func3')) ? $callback : '';
}
}
```
###(2)其他格式返回
如上面所述,当需要返回一种当前PhalApi没提供的格式时,可以:
+ 1、实现PhalApi_Response抽象中的formatResult($result)格式化返回结果
+ 2、重新注册DI()->response服务
这里以扩展XML返回格式为例,简单说明。
首先,添加实现一个XML响应子类:
```javascript
<?php
class Common_Response_XML extends PhalApi_Response {
protected function formatResult($result) {
return ArrayToXML::toXml($result);
}
}
```
关于ArrayToXML,请查看: [将PHP数组转成XML](http://www.oschina.net/code/snippet_54100_1548)
然后,重新注册:
```javascript
DI()->response = new Common_Response_XML();
```
done!
- 欢迎使用PhalApi!
- 接口,从简单开始!
- [1.1]-下载与安装
- [1.2]-创建一个自己的项目
- [1.3]-在线体验
- [1.4]-文档、帮助和官网
- [1.10]-对PhalApi框架的抉择
- [1.11]-快速入门(backup)
- [1.12]-参数规则:接口参数规则配置
- [1.13]-统一的接口请求方式:_sevice=XXX.XXX
- [1.14]-统一的返回格式和结构:ret-data-msg
- [1.15]-数据库操作:基于NotORM的使用及优化
- [1.16]-配置读取:内外网环境配置的完美切换
- [1.17]-日记纪录:简化版的日记接口
- [1.18]-快速函数:人性化的关怀
- [1.19]-DI服务速查:各资源服务一览表
- [1.20]-DB操作:数据库基本操作速查
- [1.21]-类的自动加载:遵循PEAR包的命名规范
- [1.22]-签名验证:自定义签名规则
- [1.23]-请求和响应:GET和POST两者皆可得及超越JSON格式返回
- [1.24]-缓存策略:更灵活地可配置化的多级缓存
- [1.25]-国际化翻译:为走向国际化提前做好翻译准备
- [1.26]-数据安全:数据对称加密方案
- [1.27]-精益开发:更富表现力的Model层和重量级数据获取的应对方案
- [1.28]-COOKIE:对COOKIE原生态的支持及记忆加密升级版
- [1.29]-开放与封闭:多入口和统一初始化
- [1.30]-保持的力量:接口开发最佳实践
- [1.31]-新型计划任务:以接口形式实现的计划任务
- [2.11]-核心思想:DI依赖注入-让资源更可控
- [2.12]-海量数据:可配置的分库分表
- [2.13]-接口调试:在线SQL语句查看与性能优化
- [2.14]-测试驱动开发:意图导向编程下的接口开发
- [2.15]-演进:新型计划任务续篇
- [2.16]-领域驱动设计:应对复杂领域业务的Domain层
- [2.17]-微服务:Api接口服务层
- [2.18]-定制化:资源服务的再实现
- [2.19]-扩展库:可重用的扩展类库
- [2.20]-约定编程:架构明显的编程风格
- [2.21]-服务器统一部署方案简明版:CentOs---Nginx---php-fpm---MySql-[--Memcached]
- [2.22]-更多工具:精益项目和团队建设
- [3.1]-扩展类库:微信开发
- [3.2]-扩展类库:代理模式下phprpc协议的轻松支持
- [3.3]-扩展类库:基于PHPMailer的邮件发送
- [3.4]-扩展类库:优酷开放平台接口调用
- [3.5]-扩展类库:七牛云存储接口调用
- [3.6]-扩展类库:新型计划任务
- [3.8]-扩展类库:用户、会话和第三方登录集成
- [3.9]-扩展类库:swoole支持下的长链接和异步任务实现
- [3.11]-扩展类库:基于FastRoute的快速路由
- [4.2]-开发实战2:模拟优酷开放平台接口项目开发
- [4.3]-开发实战3:一个简单的小型项目开发(奔跑吧兄弟投票活动)
- [5.1]-架构与思想:PhalApi核心设计和思想解读
- [5.2]-杂谈:扯一些PhalApi的前世和今生
- [5.3]-框架总结:术语表和PHP开发建议
- [5.4]-许可
- [5.5]-联系和加入我们
- [5.6]-更新日记
- [5.8]-致框架贡献者:加入PhalApi开源指南
- [6.1]-基于接口查询语言的SDK包
- [6.2]-SDK包(JAVA版)
- [6.3]-SDK包(PHP版)
- [6.4]-SDK包(Objective-C版)
- [6.5]-SDK包(javascript版)
- [6.6]-SDK包(Ruby版)
- [8.1]-PhalApi视频教程
- 附录1:接口文档参考模板