怎样运用 PHP 开辟 API(Application Programming Interface,运用程序编程接口) 呢?
1、和 WEB 开辟一样,起首须要一些相干的参数,这些参数,都会由客户端传过来,或许是 GET 或许是 POST,这个须要开辟团队相互之间约定好,或许制订一致范例。
2、有了参数,依据运用需求,完成数据处理,比方:使命进度更新、APP内购、一局游戏完毕数据提交等等
3、数据逻辑处理完以后,返回客户端所须要用到的相干数据,比方:使命状况、内购效果、玩家信息等等
数据怎样返给客户端?
直接输出的情势,如:JSON、XML、TEXT 等等。
4、客户端猎取到你返回的数据后,在客户端当地和用户举行交互
暂时写的一个简朴 API 例子:
<?php // 设置json花样 header('content-type:application/json;charset=utf-8'); $output = array(); $a = @$_GET['a'] ? $_GET['a'] : ''; $uid = @$_GET['uid'] ? $_GET['uid'] : 0; if (empty($a)) { $output = array('data'=>NULL, 'info'=>'数据毛病', 'code'=>-201); exit(json_encode($output)); } //走接口 if ($a == 'get_users') { //搜检用户 if ($uid == 0) { $output = array('data'=>NULL, 'info'=>'The uid is null!', 'code'=>-401); exit(json_encode($output)); } //假定 $mysql 是数据库 $mysql = array( 10001 => array( 'uid'=>10001, 'vip'=>5, 'nickname' => 'Shine X', 'email'=>'979137@qq.com', 'qq'=>979137, 'gold'=>1500, 'powerplay'=> array('2xp'=>12,'gem'=>12,'bingo'=>5,'keys'=>5,'chest'=>8), 'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17), 'ctime'=>1376523234, 'lastLogin'=>1377123144, 'level'=>19, 'exp'=>16758, ), 10002 => array( 'uid'=>10002, 'vip'=>50, 'nickname' => 'elva', 'email'=>'elva@ezhi.net', 'qq'=>NULL, 'gold'=>14320, 'powerplay'=> array('2xp'=>1,'gem'=>120,'bingo'=>51,'keys'=>5,'chest'=>8), 'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17), 'ctime'=>1376523234, 'lastLogin'=>1377123144, 'level'=>112, 'exp'=>167588, ) ); $uidArr = array(10001,10002); if (in_array($uid, $uidArr, true)) { $output = array('data' => NULL, 'info'=>'The user does not exist!', 'code' => -402); exit(json_encode($output)); } //查询数据库 $userInfo = $mysql[$uid]; //输出数据 $output = array( 'data' => array( 'userInfo' => $userInfo, 'isLogin' => true,//是不是初次上岸 'unread' => 4,//未读音讯数目 'untask' => 3,//未完成使命 ), 'info' => 'Here is the message which, commonly used in popup window', //音讯提醒,客户端常会用此作为给弹窗信息。 'code' => 200, //胜利与失利的代码,平常都是正数或许负数 ); exit(json_encode($output)); } elseif ($a == 'get_games_result') { //... die('您正在调 get_games_result 接口!'); } elseif ($a == 'upload_avatars') { //.... die('您正在调 upload_avatars 接口!'); }
关于客户端而言,直接挪用如许的地点:
http://localhost/api/test/index.php http://localhost/api/test/index.php?a=get_users http://localhost/api/test/index.php?a=get_users&uid=10001 http://localhost/api/test/index.php?a=get_users&uid=10002 http://localhost/api/test/index.php?a=get_users&uid=10003
现实项目中,我们在开辟 API 应当注重的几个事项(仅供参考):
1、单文件完成多接口的情势有很多种,比方:if..elseif.. 或 switch 或 动态要领 (也就是TP的这类接见函数体的情势)
2、关于数据的输出最好用json,json具有相称壮大的跨平台性,市场上各大主流编程言语都支撑json剖析,json正在逐渐庖代xml,成为收集数据的通用花样
3、接口平安,肯定要增添接口考证。比方,客户端和服务端针对差别接口一致做好加密体式格局,服务端在关于每次接口须要都要举行考证。以保证防备接口被歹意革新或黑客歹意挪用,尤其是大型贸易运用。
4、关于线上的 API 必需保证一切接口一般且封闭一切的毛病信息 => error_reporting(0),在输出JSON 时,不能有任何别的输出,不然,客户端将剖析数据失利,直接 Crash!
5、开辟 API 和 WEB 有肯定的区分,如果是 WEB 的话,能够代码出错了,不会致使特别严重的毛病,或许只是致使数据写入和查询失利,或许致使 WEB 的某个部份错位或乱码。但如果是 API,直接 Crash!
更多PHP相干学问,请接见ki4网!
以上就是php项目中的接口怎样写的细致内容,更多请关注ki4网别的相干文章!