作为最流行的服务端语言PHP(PHP: Hypertext Preprocessor),在开发API方面,是很简单且极具优势的。API(Application Programming Interface,应用程序接口)架构,已经成为目前互联网产品开发中常见的软件架构模式,并且诞生很多专门API服务的公司,如:聚合数据(https://www.juhe.cn/)、百度APIStore()
先了解下 API :
1、API 比开发 WEB 更简洁,但可能逻辑更复杂,API 只返回结果,也就是只完成数据输出,不呈现页面,
2、WEB 开发,更多的是 GET 和 POST 请求,API 还有 PUT、DELETE 请求
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作为客户端调用的示例:
<?php header(‘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); }
页面输出结果: