先理解下 API :

1、API 比开拓 WEB 更简洁,但可能逻辑更繁芜,API 只返回结果,也便是只完成数据输出,不呈现页面,

2、WEB 开拓,更多的是 GET 和 POST 要求,API 还有 PUT、DELETE 要求

php开发接口开发PHP开辟API接口 Docker

3、和 WEB 开拓一样,首先须要一些干系的参数,这些参数,都会由客户端传过来,大概是 GET 大概是 POST,这个须要开拓团队相互之间约定好,或者制订统一规范

4、有了参数,根据运用需求,完成数据处理,例如:获取用户信息、发朋友圈、发、一局游戏结束数据提交等等

5、数据逻辑处理完之后,返回客户端所须要用到的干系数据,例如:用户信息数组、朋友圈列表、状态、游戏结果数据等等,那数据是怎么返给客户端呢?常见有XML、JSON,设置相应的header并把要返回的数据直接打印出来即可

6、客户端获取到你返回的数据后,在客户端本地和用户进行交互

以是我们大概知道,API 实在不存在Web领域的 MVC 架构模式,若要分层的,API 也只有 M 和 C 两层,当然,后端可能会有更加繁芜的架构!

通过下面一个HTTP协议的API实例来理解PHP怎么开拓API:

<?php/ 比较标准的接口输出函数 @param string $info @param integer $code 接口缺点码,很关键的参数 @param array $data 附加数据 $param string $location 重定向 @return array/function var_json($info = '', $code = 10000, $data = array(), $location = '') { $out['code'] = $code ?: 0; $out['info'] = $info ?: ($out['code'] ? 'error' : 'success'); $out['data'] = $data ?: array(); $out['location'] = $location; header('Content-Type: application/json; charset=utf-8'); echo json_encode($out, JSON_HEX_TAG); exit(0);}$a = empty($_GET['a']) ? '' : $_GET['a'];$qq = empty($_GET['qq']) ? 0 : intval($_GET['qq']);//假设这是数据源,如MySQL$data = array();$data[979136] = array('qq'=>979136, 'vip'=>5,'level'=>128, 'reg_time'=>1376523234, 'qb'=>300);$data[979137] = array('qq'=>979137, 'vip'=>8,'level'=>101, 'reg_time'=>1377123144, 'qb'=>300);preg_match('/^[a-zA-Z]+$/', $a) || var_json('造孽调用');isset($data[$qq]) || var_json('用户不存在', 100001);switch ($a) { //获取用户基本信息 case 'info': //你的更多业务逻辑 ... var_json('success', 0, $data[$qq]); break; //获取动态 case 'message': var_json('您正在调用动态接口', 0); break; //获取好友列表 case 'friends': var_json('你正在调用好友列表接口', 0); break; default: var_json('造孽调用');}

接口输出示例,返回的是一串json:

{ \"大众code\"大众: 0, \公众info\"大众: \公众success\"大众, \公众data\公众: { \"大众qq\公众: 979137, \"大众vip\公众: 8, \"大众level\"大众: 101, \公众reg_time\公众: 1377123144, \"大众qb\"大众: 300 }, \"大众location\"大众: \"大众\"大众}

json具有很强的跨平台性,险些每种措辞都有解析json的函数,下面是一个PHP作为客户端调用的示例:

<?phpheader('Content-type:text/html;charset=utf-8');$url = \"大众http://demo.979137.com/api/test/user.php?a=info&qq=979137\"大众;$arg = array( 'a' => 'info', 'qq' => '979137',);$query_string = http_build_query($arg);$ch = curl_init($url.'?'.$query_string);curl_setopt($ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1);curl_setopt($ch, CURLOPT_USERAGENT , 'QQ_Mobile_V5.5');curl_setopt($ch, CURLOPT_CONNECTTIMEOUT , 60 );curl_setopt($ch, CURLOPT_TIMEOUT , 60);curl_setopt($ch, CURLOPT_RETURNTRANSFER , true);curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);$response = curl_exec($ch);$httpcode = curl_getinfo($ch , CURLINFO_HTTP_CODE);curl_close($ch);if ($response === false) { var_dump(curl_error($ch));} elseif ($httpcode != 200) { var_dump($httpcode, '接口要求失落败');} else { $ret = json_decode($response, true); var_dump($ret);}

页面输出结果:

array(4) { [\"大众code\公众]=>int(0) [\"大众info\"大众]=>string(7) \"大众success\"大众 [\公众data\"大众]=> array(5) { [\公众qq\"大众]=>int(979137) [\"大众vip\"大众]=>int(8) [\公众level\"大众]=>int(101) [\公众reg_time\公众]=>int(1377123144) [\公众qb\"大众]=>int(300) } [\"大众location\公众]=>string(0) \"大众\"大众}

实际项目中,我们在开拓 API 时该当把稳的几个点

1、单文件实现多接口的形式有很多种,例如:if..elseif.. 或 switch 或 很多框架里用到的统一入口通过调用类函数的形式实现

2、数据输出建议利用json,json具有很强的跨平台性,大多编程措辞都支持json解析,json正在逐步取代xml,成为网络数据的通用格式

3、为了担保接口安全,一定要加入鉴权体系

4、对付线上的API,务必关闭所有缺点显示,可以把缺点写到日志里,PHP中,可以通过 error_reporting(0) 屏蔽所有缺点

这样做的目的,一方面是保护接口安全,防止输出不该打印的缺点信息

另一方面是担保输出的是精确的数据格式,如json,如果不是标准的json格式,客户端在解析时就会出错,由此影响客户真个正常运转

PS:我们平时在利用手机APP时,手机会闪退,多数是这个缘故原由,即接口调用非常

5、开拓 API 和 WEB 有一定的差异,如果是 WEB 的话,如果程序写的有问题,比如有个notice 或 warning 级别的缺点,在 WEB 里可能不会有什么问题,大概就只是导致 WEB 的某个部分错位或乱码。
但如果是 API,就会严重调用的客户端了,如果是手机APP,那闪推啥的,是一定的,如果同样也是Web调用,也可能会涌现 Server Error 了

6、一定要重点考虑稳定性和相应速率,由于我们在利用手机APP时,都不肯望APP常常闪推、而且希望运用很流畅

7、不要随便利用一些 PHP 开源框架,缘故原由概括起来有两点:

1)如6所述,客户端一样平常对 API 相应速率有极高哀求,目前PHP领域的开源框架非常多,根据笔者的理解,目前比较盛行的框架,普遍做的比较重,而且基本都是为WEB而生,因此,框架多了很多 API 用不到的东西,框架在加载和实行冗余文件时,实际是在花费你的性能

2)如4和5所述,框架对付WEB开拓,是件很幸福的事,但对付 API 而言,你实在不敢想象它会给你出什么岔子,由于很多框架并没有全面的考虑到 API 场景