首页 > 代码库 > API接口开发简述示例
API接口开发简述示例
作为最流行的服务端语言PHP（PHP: Hypertext Preprocessor），在开发API方面，是很简单且极具优势的。API（Application Programming Interface，应用程序接口）架构，已经成为目前互联网产品开发中常见的软件架构模式，并且诞生很多专门API服务的公司，如：聚合数据（https://www.juhe.cn/）、百度APIStore（http://apistore.baidu.com/）
先了解下 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作为客户端调用的示例：
<?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 场景
API接口开发简述示例