php get请求 json返回,[1.23]-请求和响应:GET和POST两者皆可得及超越JSON格式返回 | PhalApi(π框架) - PHP轻量级开源接口框架 - 接口,从简单开始!...
1.23.1 请求
把我们后台的API想象成一个函数,那么请求的参数就是我们的参数列表;而接口响应的数据则对应函数返回的结果。
对于请求,正如前面所看到的,我们可以使用$_GET,也可以使用$_POST,也可以两者都使用,还可以在测试时自己指定模拟的请求数据包。
或者,在实际项目开发中,我们还需要根据自身的需求,跟我们自己的客户端作一些约定。如通常地,我们会要求客户端 service参数必须用GET方式 ,以便服务器返回500时定位接口服务位置。对此,简单的我们把$_POST['service']去掉即可,如在入口文件前面添加:
unset($_POST['service']); //只接收GET方式的service参数
(1) 在index.php入口处指定数据源
很多时间,不同的项目对数据接收有不同的需求。如简单地,强制统一使用$_POST参数,我们可以这样在入口处进行代码调整:
//vim ./index.php
DI()->request = new PhalApi_Request($_POST);
对于复杂的情况,如需要使用post_raw数据,则可以继承PhalApi_Request实现相应的数据源解析。如:
class My_Request extends PhalApi_Request{
public function __construct($data = NULL) {
parent::__construct($data);
// json处理
$this->post = json_decode(file_get_contents('php://input'), TRUE);
// 普通xml处理
$this->post = simplexml_load_string (
file_get_contents('php://input'),
'SimpleXMLElement',
LIBXML_NOCDATA
);
$this->post = json_decode(json_encode($this->post), TRUE);
}
}
然后在子类实现对各类参数的数据源的准备。可以说,PhalApi_Request::__construct()构造函数用于初始化各类辅助侯选的数据源,而PhalApi_Request::getData()则用于生成主要默认的数据源。
(2) 单元测试时指定数据源
在进行单元测试时,我们需要模拟接口的请求动作,也需要提供接口参数。这时的参数的指定更为灵活。可通过以下代码来实现,即:
//数据源
$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']来传递,则相应的解析代码如下。
第一步,先定义自己的扩展请求类,在里面完成对称解析的动作:
class Common_Request extends PhalApi_Request {
public function genData($data) {
if (!isset($data) || !is_array($data)) {
$data = $_POST; //改成只接收POST
}
return isset($data['data']) ? base64_decode($data['data']) : array();
}
}
第二步,在index.php入口文件中重新注册请求类(即添加以下代码):
//重新注册request
DI()->request = 'Common_Request';
然后,就可以轻松实现了接口参数的对称加密传送。
至此,你也许已经发现:指定数据源和对称加密是可以结合来使用的。
(4) 接口参数级别的数据源
除了可以指定全局的接口数据源外,还可以进行更细致的配置,即为某个接口参数指定使用$GET、$_POST、$_COOKIE、$_SERVER、$_REQUEST或头部等其他数据源。
其使用方式是在配置接口参数规则时,使用source配置来指定当前参数的数据源,如指定用户在登录时,用户名使用$_GET、密码使用$_POST。
public function getRules() {
return array(
'login' => array(
'username' => array('name' => 'username', 'source' => 'get'),
'password' => array('name' => 'password', 'source' => 'post'),
),
);
}
这样,PhalApi框架就会从$_GET中提取username参数,从$_POST中提取password参数。
目前支持的source与对应的数据源映射关系如下:
source
对应的数据源
post
$_POST
get
$_GET
cookie
$_COOKIE
server
$_SERVER
requset
$_REQUEST
header
$_SERVER['HTTP_X']
因此,这样就可以轻松、更自由获取不同来源的参数。以下是一些常用的配置示例。
// 获取HTTP请求方法,判断是POST还是GET
'method' => array('name' => 'REQUEST_METHOD', 'source' => 'server'),
// 获取COOKIE中的标识
'is_new_user' => array('name' => 'is_new_user', 'source' => 'cookie'),
// 获取HTTP头部中的编码,判断是否为utf-8
'charset' => array('name' => 'Accept-Charset', 'source' => 'header'),
若需要扩展项目自定义的映射关系,则可以重载PhalApi_Request::getDataBySource($source)方法,如:
class My_Request extends PhalApi_Request {
protected function &getDataBySource($source) {
if (strtoupper($source) == 'stream') {
// TODO 处理二进制流
}
return parent::getDataBySource($source);
}
}
然后,便可在项目中这样配置使用二进制流的数据源。
// 从二进制流中获取密码
'password' => array('name' => 'password', 'source' => 'stream'),
若配置的source为无效或非法时,则会抛出异常。
如故意配置一个错误的数据源source为NOT_FOUND。
'password' => array('name' => 'password', 'source' => 'NOT_FOUND'),
在请求接口时,会遇到这样的异常提示返回。
{
"ret": 500,
"data": [],
"msg": "服务器运行错误: 参数规则中未知的数据源:NOT_FOUND"
}
温馨提示:以上功能需要PhalApi 1.4.0 及以上版本支持。
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 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响应子类:
class Common_Response_XML extends PhalApi_Response {
protected function formatResult($result) {
return ArrayToXML::toXml($result);
}
}
关于ArrayToXML,请查看: 将PHP数组转成XML
然后,重新注册:
DI()->response = new Common_Response_XML();
done!
php get请求 json返回,[1.23]-请求和响应:GET和POST两者皆可得及超越JSON格式返回 | PhalApi(π框架) - PHP轻量级开源接口框架 - 接口,从简单开始!...相关推荐
- postman 返回json乱码_POSTMAN发起请求收到乱码 http 406错误
web前段异常: The resource identified by this request is only capable of generating responses with charac ...
- Android复习04(适配器 Get()请求 适配器 getView()方法 Post()请求 保存Cookie 流转字符串 从网上获取图片 重点考Json解析)
目 录 适配器 Get()请求 适配器 getView()方法 Post()请求 保存Cookie 流转字符串 从网上获取图片 重点考Json解析 适配器 Get()请求 适配器 getView( ...
- android多接口请求参数,okhttp3 使用json参数post方式请求接口数据(android)
1. 谷歌自带的json不支持像map一样直接put字符串进去,所以先导入阿里的json包 2. 创建json对象,并且放入所要请求的参数 //登录 private void loginRequest ...
- html设置json请求头,当我想在zf2客户端代码中使用“application/json”时,接受请求标头是“text/html,application/xhtm ...(etc)”...
我有一个完全可用的API设置,并且zf2客户端I已经在理论上建立了工作,但无论如何,我似乎无法将来自客户端的JSON请求发送到API.每当我测试一下我不断收到以下标题而这又返回406错误:当我想在zf ...
- ajax请求解析json,如何为Ajax请求解析json响应?
我是ajax/javascript的新手.我试图解析响应下面Ajax请求:如何为Ajax请求解析json响应? function invokeMediationRestService(rql) { v ...
- python发post请求json_python request 以json形式发送post请求的正确的姿势
一个http请求包括三个部分,为别为请求行,请求报头,消息主体,类似以下这样: 请求行,请求报头,消息主题. 以json串提交数据,编码格式: application/json, 必须加上 impor ...
- js:json请求和jsonp请求
请求方式 同源检查 解决方式 json 是 服务端支持 jsonp 否 不需要服务端支持 目录 一.使用json请求 1.1 未开启跨域 1.2 开启跨域 二.使用jsonp 一.使用json请求 1 ...
- C++通过HTTP请求Get或Post方式请求Json数据(转)
原文网址:https://www.cnblogs.com/shike8080/articles/6549339.html #pragma once #include <iostream> ...
- Retrofit网络请求参数注解,@Path、@Query、@Post、Body等总结(超级实用)以及以Json格式和form-data格式提交数据
我总结的不是很全,这位博主介绍的十分详细:超级实用 https://blog.csdn.net/guohaosir/article/details/78942485 Retrofit 以Json格式提 ...
最新文章
- 给妹子讲python-S01E19解析Python内嵌作用域与函数闭包
- 我所理解的设计模式(C++实现)——策略模式(Strategy Pattern)
- mingw64 下 java,如何安装MinGW-w64和MSYS2?
- MicroBlaze软核介绍
- 18岁男子吸电子烟一年肺如70岁老人,怒诉电子烟公司
- java compiler.run_eclipse build path与java Compiler
- 电子模块 001 --- 遥杆 JoyStick
- 牛B装备 XSS 漏洞利用工具[使用教程]
- php页面打开响应时间
- 2021年最新超火外卖侠cps小程序,三级分销返利外卖领劵小程序源码,带电影票分销积分商城
- mysql有mdf文件和ldf文件吗_mdf与ldf文件格式
- adguard和adblock哪个好_这可能是最全的广告屏蔽方案了!
- 手动释放ubuntu内存
- windows保护无法启动修复服务器,win10系统使用“sfc /scannow”修复系统提示Windows资源保护无法启动修复服务怎么办...
- rf 433/868MHZ sub-1g 无线通信知识系列(3):组网信道
- 【ThinkPad系统重装】
- Apache Kylin Buid Cube详细流程2
- iOS 对接TopOn聚合广告心得
- 赵筱赟:十年后的中国远超你想象
- 怎么把图片文字转换成word文档?介绍一个方法
热门文章
- java语音开源_号外!号外!百度语音开源库更新了
- android 图片特征提取比对_判断ImageView当前的图片是哪个图片,然后比对资源文件的操作...
- python super用法
- [网络开发]服务器开发
- priority_queue的用法
- Unity UGUI——Rect Transform包裹(Anchor Presets)
- 2014年06月30日
- 并行、并发,两者的区别
- Android 曲线图绘制
- c#文件操作Streamwriter, streamreader的使用