api 接口开发理论 在php中调用接口以及编写接口

时间：2023-02-02 20:20:50

如：
http://localhost/openUser.php?act=get_user_list&type=json

在这里openUser.php相当于一个接口，其中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、WinBinder）

2、为什么选择 PHP 作为开发服务端的首选？
答：跨平台（可以运行在UNIX、Linux、WINDOWS、Mac OS下）、低消耗（PHP消耗相当少的系统资源）、运行效率高（相对而言）、MySQL的完美搭档，本身是免费开源的，......

二、如何使用 PHP 开发 API（Application Programming Interface，应用程序编程接口） 呢？

做过 API 的人应该了解，其实开发 API 比开发 WEB 更简洁，但可能逻辑更复杂，因为 API 其实就是数据输出，不用呈现页面，所以也就不存在 MVC（API 只有 M 和 C），
1、和 WEB 开发一样，首先需要一些相关的参数，这些参数，都会由客户端传过来，也许是 GET 也许是 POST，这个需要开发团队相互之间约定好，或者制定统一规范。
2、有了参数，根据应用需求，完成数据处理，例如：任务进度更新、APP内购、一局游戏结束数据提交等等
3、数据逻辑处理完之后，返回客户端所需要用到的相关数据，例如：任务状态、内购结果、玩家信息等等
数据怎么返给客户端？
直接输出的形式，如：JSON、XML、TEXT 等等。
4、客户端获取到你返回的数据后，在客户端本地和用户进行交互

临时写的一个简单 API 例子：

  1. <?php
  2. $output = array();
  3. $a = @$_GET['a'] ? $_GET['a'] : '';
  4. $uid = @$_GET['uid'] ? $_GET['uid'] : 0;
  5. if (empty($a)) {
  6. $output = array('data'=>NULL, 'info'=>'坑爹啊!', 'code'=>-201);
  7. exit(json_encode($output));
  8. }
  9. //走接口
  10. if ($a == 'get_users') {
  11. //检查用户
  12. if ($uid == 0) {
  13. $output = array('data'=>NULL, 'info'=>'The uid is null!', 'code'=>-401);
  14. exit(json_encode($output));
  15. }
  16. //假设 $mysql 是数据库
  17. $mysql = array(
  18. 10001 => array(
  19. 'uid'=>10001,
  20. 'vip'=>5,
  21. 'nickname' => 'Shine X',
  22. 'email'=>'979137@qq.com',
  23. 'qq'=>979137,
  24. 'gold'=>1500,
  25. 'powerplay'=> array('2xp'=>12,'gem'=>12,'bingo'=>5,'keys'=>5,'chest'=>8),
  26. 'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17),
  27. 'ctime'=>1376523234,
  28. 'lastLogin'=>1377123144,
  29. 'level'=>19,
  30. 'exp'=>16758,
  31. ),
  32. 10002 => array(
  33. 'uid'=>10002,
  34. 'vip'=>50,
  35. 'nickname' => 'elva',
  36. 'email'=>'elva@ezhi.net',
  37. 'qq'=>NULL,
  38. 'gold'=>14320,
  39. 'powerplay'=> array('2xp'=>1,'gem'=>120,'bingo'=>51,'keys'=>5,'chest'=>8),
  40. 'gems'=> array('red'=>13,'green'=>3,'blue'=>8,'yellow'=>17),
  41. 'ctime'=>1376523234,
  42. 'lastLogin'=>1377123144,
  43. 'level'=>112,
  44. 'exp'=>167588,
  45. ),
  46. 10003 => array(
  47. 'uid' => 10003,
  48. 'vip' => 5,
  49. 'nickname' => 'Lily',
  50. 'email' => 'Lily@ezhi.net',
  51. 'qq' => NULL,
  52. 'gold' => 1541,
  53. 'powerplay'=> array('2xp'=>2,'gem'=>112,'bingo'=>4,'keys'=>7,'chest'=>8),
  54. 'gems' => array('red'=>13,'green'=>3,'blue'=>9,'yellow'=>7),
  55. 'ctime' => 1376523234,
  56. 'lastLogin'=> 1377123144,
  57. 'level' => 10,
  58. 'exp' => 1758,
  59. ),
  60. );
  61. $uidArr = array(10001,10002,10003);
  62. if (in_array($uid, $uidArr, true)) {
  63. $output = array('data' => NULL, 'info'=>'The user does not exist!', 'code' => -402);
  64. exit(json_encode($output));
  65. }
  66. //查询数据库
  67. $userInfo = $mysql[$uid];
  68. //输出数据
  69. $output = array(
  70. 'data' => array(
  71. 'userInfo' => $userInfo,
  72. 'isLogin' => true,//是否首次登陆
  73. 'unread' => 4,//未读消息数量
  74. 'untask' => 3,//未完成任务
  75. ),
  76. 'info' => 'Here is the message which, commonly used in popup window', //消息提示，客户端常会用此作为给弹窗信息。
  77. 'code' => 200, //成功与失败的代码，一般都是正数或者负数
  78. );
  79. exit(json_encode($output));
  80. } elseif ($a == 'get_games_result') {
  81. //...
  82. die('您正在调 get_games_result 接口!');
  83. } elseif ($a == 'upload_avatars') {
  84. //....
  85. die('您正在调 upload_avatars 接口!');
  86. }
复制代码

点击测试（对于客户端而言，也是直接调用这样的地址）：
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

三、实际项目中，我们在开发 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！
6、做接口开发，不建议使用框架开发，原因概括起来有两点（其实我有点冒风险的，本人也是 TPer 一枚，毕竟这是TP的官网）：
　　1）客户端一般对服务端的响应速度有极高要求，因此，使用最原生态的 PHP
完成接口开发，是最高效的，假如用到了框架，还需要加载各种不需要多余的文件，就好比夏天穿了件冬天的衣服。试想，你在玩手机的时候，使用一个应用随便一个操作，等半天才有动静，你受的了吗？

　　2）就是上面第4点提到的，框架对于WEB开发，是件很幸福的事，但对于 API 而言，你实在不敢想象它会给你出什么岔子！最后你将痛苦不堪~~因为很多框架都是为 WEB 诞生的（我也很期待有一天能看到专门为开发 API 而生的框架或者扩展）

　　这个也有人纠结，接口效率与稳定性，还得看编码的人，有的人可能写的还不如框架跑的快，也有人觉得用框架没什么问题，这里只是建议，关键看自己的实际情况，同时建议代码上线前压测一下

　　说到这，不得不说扯一下，腾讯微博淘宝等开放平台。其实那些开放平台，所谓的开放，就是给你提供一个这样的接口，你根据他们提供的技术文档，按他们制定的格式和要求，调它们提供的接口文件（一般都是返回JSON或者XML），你就可以获取到他们的相关信息，例如：QQ用户基本信息、淘宝店铺、商品消息等等。然后在根据这些消息，在你的应用里完成交互。

　　其实，ajax 也是调用 API 的接口

相关文章