如:
Here.php 等同于一个接口,其中 API (Get User List) 是 API,返回的数据类型为 JSON 格式。
你只需要在你的 php 代码中执行这个链接,它就会返回。
Get 方法
$file_contents = file_get_content('http://localhost/openUser.php?act=get_user_list&type=json')
POST 方法需要满足以下条件(需要启用 PHP curl 支持)。
$url = 'http://localhost/openUser.php?act=get_user_list&type=json'; $ch = curl_init (); curl_setopt ( $ch, CURLOPT_URL, $url ); curl_setopt ( $ch, CURLOPT_RETURNTRANSFER, 1 ); curl_setopt ( $ch, CURLOPT_CONNECTTIMEOUT, 10 ); curl_setopt ( $ch, CURLOPT_POST, 1 ); //启用POST提交 $file_contents = curl_exec ( $ch ); curl_close ( $ch );
用PHP编写接口
首先,简要回答两个问题:
1. PHP可以开发客户端吗?
答:不可以,因为PHP是一种脚本语言,它负责完成B/S架构或C/S架构的S部分,即服务器的开发。(不要打扰 GTK,)。
2. 为什么选择PHP作为开发服务器的首选?
答:跨平台(可以在UNIX、LINUX、Mac OS下运行)、低功耗(PHP消耗相当少的系统资源)、高运行效率(相对而言),MySQL是一个完美的合作伙伴,本身就是免费开源的,......
2. 如何使用PHP开发API( )?任何做过 API 的人都应该明白,开发 API 其实
比开发 WEB 更简洁,但逻辑可能更复杂,因为 API 其实是数据输出,不需要渲染页面,所以没有 MVC(API 只有 M 和 C)。
1.像WEB开发一样,你首先需要一些相关的参数,这些参数会由客户端传递,可能是GET或POST,这需要开发团队之间达成一致,或者制定一个统一的规范。
2.带参数,根据应用需求完成数据处理,如:任务进度更新、APP应用内购买、游戏结束时数据提交等
3.数据后
逻辑处理后,会返回客户端需要的相关数据,如:任务状态、应用内购买结果、玩家信息等
如何将数据返回给客户端?
直接输出形式,如:JSON、XML、TEXT等。
4. 客户之后
获取返回的数据,在客户端本地与用户交互临时
编写的简单 API 示例:
<?php $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, ), 10003 => array( 'uid' => 10003, 'vip' => 5, 'nickname' => 'Lily', 'email' => 'Lily@ezhi.net', 'qq' => NULL, 'gold' => 1541, 'powerplay'=> array('2xp'=>2,'gem'=>112,'bingo'=>4,'keys'=>7,'chest'=>8), 'gems' => array('red'=>13,'green'=>3,'blue'=>9,'yellow'=>7), 'ctime' => 1376523234, 'lastLogin'=> 1377123144, 'level' => 10, 'exp' => 1758, ), ); $uidArr = array(10001,10002,10003); 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 接口!'); }
复制代码
点击 test(对于客户端,也可以直接调用这样的地址):
http://www.ezhi.net/api/test/index.php http://www.ezhi.net/api/test/index.php?a=get_users http://www.ezhi.net/api/test/index.php?a=get_users&uid=10001 http://www.ezhi.net/api/test/index.php?a=get_users&uid=10002 http://www.ezhi.net/api/test/index.php?a=get_users&uid=10003
3. 在实际项目中,我们在开发 API 时需要注意几点(仅供参考):
1. 在单个文件中实现多个接口的方法有很多种,例如:if....或动态方法(即 TP 的这种访问函数体的形式)。
2.对于数据的输出,最好使用JSON,JSON具有非常强的跨平台性,市面上所有主流编程语言都支持JSON解析,JSON正在逐渐取代XML,成为网络数据的通用格式
3.接口安全,一定要加大接口验证力度。例如,客户端和服务器对不同的接口有统一的加密方法,服务器需要对每个接口进行验证。确保接口免受黑客的恶意刷新或恶意调用,尤其是对于大型商业应用程序。
4. 对于在线 API,必须保证所有接口正常并关闭所有错误消息 => (0),输出 JSON 时不能有其他输出,否则客户端解析数据失败直接崩溃!
5. 开发 API 和 WEB 是有一定区别的,如果是 WEB,代码可能出错,
不会导致特别严重的错误,可能只会导致数据写入和查询失败,也可能导致网页的某个部分放错位置或乱码。但如果是 API,那就崩溃吧!
6.做接口开发,不建议用框架开发,原因有二(其实我有点冒险,而且我也是TPer,毕竟这里是TP官网):
1)客户端一般对服务器的响应速度有极高的要求,所以使用最原始的PHP来完成接口开发是最有效率的。试想一下,当你玩手机,用一个APP随便操作,等了半天才有动静,你受得了吗?
2) 如上文第 4 点所述,框架对 WEB 开发来说是一件快乐的事情,但对于 API 来说,你无法想象它能为你做什么!最后,你会很痛苦~~因为很多框架都是为WEB构建的(我期待有一天能看到专门用于API开发的框架或扩展)。有
的人可能写得不如框架快,有的人觉得使用框架没有问题,这里只是一个建议,关键要看自己的实际情况,建议上线前先对代码进行压力测试说
到这里,不得不说腾讯、微博、淘宝等开放平台。其实那些开放平台,所谓开放,就是给你提供这样的接口,你根据他们提供的技术文档,根据他们制定的格式和要求,调整他们提供的接口文件(一般返回JSON或者XML),就可以得到他们的相关信息,比如:QQ用户基本信息、淘宝店铺、 产品新闻等然后,根据这些消息,在应用中完成交互。
事实上,ajax 也是一个调用 API 的接口