php项目中的接口怎么写-PHP问题

1、和 WEB 开发一样，首先需要一些相关的参数，这些参数，都会由客户端传过来，也许是 GET 也许是 POST，这个需要开发团队相互之间约定好，或者制定统一规范。

2、有了参数，根据应用需求，完成数据处理，例如：任务进度更新、APP内购、一局游戏结束数据提交等等

3、数据逻辑处理完之后，返回客户端所需要用到的相关数据，例如：任务状态、内购结果、玩家信息等等

数据怎么返给客户端？

直接输出的形式，如：JSON、XML、TEXT 等等。

4、客户端获取到你返回的数据后，在客户端本地和用户进行交互

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

NULL, &＃39;info&＃39;=>&＃39;数据错误&＃39;, &＃39;code&＃39;=>-201);
    exit(json_encode($output));
}
//走接口
if ($a == &＃39;get_users&＃39;) {
    //检查用户
    if ($uid == 0) {
        $output = array(&＃39;data&＃39;=>NULL, &＃39;info&＃39;=>&＃39;The uid is null!&＃39;, &＃39;code&＃39;=>-401);
        exit(json_encode($output));
    }
    //假设 $mysql 是数据库
    $mysql = array(
        10001 => array(
            &＃39;uid&＃39;=>10001,
            &＃39;vip&＃39;=>5,
            &＃39;nickname&＃39; => &＃39;Shine X&＃39;,
            &＃39;email&＃39;=>&＃39;979137@qq.com&＃39;,
            &＃39;qq&＃39;=>979137,
            &＃39;gold&＃39;=>1500,
            &＃39;powerplay&＃39;=> array(&＃39;2xp&＃39;=>12,&＃39;gem&＃39;=>12,&＃39;bingo&＃39;=>5,&＃39;keys&＃39;=>5,&＃39;chest&＃39;=>8),
            &＃39;gems&＃39;=> array(&＃39;red&＃39;=>13,&＃39;green&＃39;=>3,&＃39;blue&＃39;=>8,&＃39;yellow&＃39;=>17),
            &＃39;ctime&＃39;=>1376523234,
            &＃39;lastLogin&＃39;=>1377123144,
            &＃39;level&＃39;=>19,
            &＃39;exp&＃39;=>16758,
        ),
        10002 => array(
            &＃39;uid&＃39;=>10002,
            &＃39;vip&＃39;=>50,
            &＃39;nickname&＃39; => &＃39;elva&＃39;,
            &＃39;email&＃39;=>&＃39;elva@ezhi.net&＃39;,
            &＃39;qq&＃39;=>NULL,
            &＃39;gold&＃39;=>14320,
            &＃39;powerplay&＃39;=> array(&＃39;2xp&＃39;=>1,&＃39;gem&＃39;=>120,&＃39;bingo&＃39;=>51,&＃39;keys&＃39;=>5,&＃39;chest&＃39;=>8),
            &＃39;gems&＃39;=> array(&＃39;red&＃39;=>13,&＃39;green&＃39;=>3,&＃39;blue&＃39;=>8,&＃39;yellow&＃39;=>17),
            &＃39;ctime&＃39;=>1376523234,
            &＃39;lastLogin&＃39;=>1377123144,
            &＃39;level&＃39;=>112,
            &＃39;exp&＃39;=>167588,
        )
    );
    
    $uidArr = array(10001,10002);
    if (in_array($uid, $uidArr, true)) {
        $output = array(&＃39;data&＃39; => NULL, &＃39;info&＃39;=>&＃39;The user does not exist!&＃39;, &＃39;code&＃39; => -402);
        exit(json_encode($output));
    }
    //查询数据库
    $userInfo = $mysql[$uid];
    
    //输出数据
    $output = array(
        &＃39;data&＃39; => array(
            &＃39;userInfo&＃39; => $userInfo,
            &＃39;isLogin&＃39; => true,//是否首次登陆
            &＃39;unread&＃39; => 4,//未读消息数量
            &＃39;untask&＃39; => 3,//未完成任务
        ), 
        &＃39;info&＃39; => &＃39;Here is the message which, commonly used in popup window&＃39;, //消息提示，客户端常会用此作为给弹窗信息。
        &＃39;code&＃39; => 200, //成功与失败的代码，一般都是正数或者负数
    );
    exit(json_encode($output));
} elseif ($a == &＃39;get_games_result&＃39;) {
    //...
    die(&＃39;您正在调 get_games_result 接口!&＃39;);
} elseif ($a == &＃39;upload_avatars&＃39;) {
    //....
    die(&＃39;您正在调 upload_avatars 接口!&＃39;);
}

对于客户端而言，直接调用这样的地址：

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相关知识，请访问PHP中文网！

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