php项目中的接口怎么写

php  /  管理员 发布于 7年前   143

如何使用 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'=>'[email protected]','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'=>'[email protected]','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.phphttp://localhost/api/test/index.php?a=get_usershttp://localhost/api/test/index.php?a=get_users&uid=10001http://localhost/api/test/index.php?a=get_users&uid=10002http://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相关知识，请访问！

以上就是php项目中的接口怎么写的详细内容，更多请关注其它相关文章！