1.23.1 请求
把我们后台的API想象成一个函数,那么请求的参数就是我们的参数列表;而接口响应的数据则对应函数返回的结果。
对于请求,正如前面所看到的,我们可以使用$_GET,也可以使用$_POST,也可以两者都使用,还可以在测试时自己指定模拟的请求数据包。
或者,在实际项目开发中,我们还需要根据自身的需求,跟我们自己的客户端作一些约定。如通常地,我们会要求客户端 service参数必须用GET方式 ,以便服务器返回500时定位接口服务位置。对此,简单的我们把$_POST['service']去掉即可,如在入口文件前面添加:
unset($_POST['service']); //只接收GET方式的service参数
1.23.2 响应
当前默认使用JSON的格式返回,但项目需要其他返回格式也是可以的。只需要实现PhalApi_Response抽象中的formatResult($result)格式化返回结果,然后也是重新注册DI()->response服务即可。如:
(1)JSONP的返回
在H5页面中,我们可能会需要用到JSONP的返回,所以这里默认提供了这种格式的支持。
在入口文件中,添加:
//支持JsonP的返回if (!empty($_GET['callback'])) { DI()->response = new PhalApi_Response_JsonP($_GET['callback']);}
在接口访问时再带上&callback=XXX参数即可。
这里在创建响应服务时,可以看到是用了回调函数的名字进行初始化。考虑到会存在XSS(跨站脚本攻击),对回调函数要进行相应的过滤,可以用黑名单或者白名单的方式。黑名单方式暂时还没提供,白名单相对简单但需要项目自己实现,如:
class MyResponse_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响应子类:
class MyResponse_XML extends PhalApi_Response { protected function formatResult($result) { return ArrayToXML::toXml($result); }}
关于ArrayToXML,请查看:
然后,重新注册:
DI()->response = new MyResponse_XML();
done!