API接⼝开发简述简单⽰例
作为最流⾏的服务端语⾔PHP（PHP: Hypertext Preprocessor），在开发API⽅⾯，是很简单且极具优势的。API（Application Programming Interface，应⽤程序接⼝）架构，已经成为⽬前互联⽹产品开发中常见的软件架构模式，并且诞⽣很多专门API服务的公司，如：聚合数据（）、百度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：
/**
* ⽐较标准的接⼝输出函数
* @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作为客户端调⽤的⽰例：
header('Content-type:text/html;charset=utf-8');
$url = "demo.979137/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 或很多框架⾥⽤到的统⼀⼊⼝通过调⽤类函数的形式实现
webserver接口开发
2、数据输出建议使⽤json，json具有很强的跨平台性，⼤多编程语⾔都⽀持json解析，json正在逐步取代xml，成为⽹络数据的通⽤格式
3、为了保证接⼝安全，⼀定要加⼊鉴权体系
4、对于线上的API，务必关闭所有错误显⽰，可以把错误写到⽇志⾥，PHP中，可以通过 error_reporting(0) 屏蔽所有错误
这样做的⽬的，⼀⽅⾯是保护接⼝安全，防⽌输出不该打印的错误信息
另⼀⽅⾯是保证输出的是正确的数据格式，如json，假如不是标准的json格式，客户端在解析时就会出错，由此影响客户端的正常运转PS：我们平时在使⽤⼿机APP时，⼿机会闪退，多半是这个原因，即接⼝调⽤异常
5、开发 API 和 WEB 有⼀定的区别，如果是 WEB 的话，如果程序写的有问题，⽐如有个notice 或 w
arning 级别的错误，在 WEB ⾥可能不会有什么问题，也许就只是导致 WEB 的某个部分错位或乱码。但如果是 API，就会严重调⽤的客户端了，如果是⼿机APP，那闪推啥的，是必然的，如果同样也是Web调⽤，也可能会出现  Server Error 了
6、⼀定要重点考虑稳定性和响应速度，因为我们在使⽤⼿机APP时，都不希望APP经常闪推、⽽且希望应⽤很流畅
7、不要随便使⽤⼀些 PHP 开源框架，原因概括起来有两点：
1）如6所述，客户端⼀般对 API 响应速度有极⾼要求，⽬前PHP领域的开源框架⾮常多，根据笔者的了解，⽬前⽐较流⾏的框架，普遍做的⽐较重，⽽且基本都是为WEB⽽⽣，因此，框架多了很多 API ⽤不到的东西，框架在加载和执⾏冗余⽂件时，实际是在消耗你的性能    2）如4和5所述，框架对于WEB开发，是件很幸福的事，但对于 API ⽽⾔，你实在不敢想象它会给你出什么岔⼦，因为很多框架并没有全⾯的考虑到 API 场景

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。