How to write the interface in php project-PHP Problem-php.cn

How to write the interface in php project

angryTom

Release： 2023-02-28 11:02:02

Original

2487 people have browsed it

How to use PHP to develop API (Application Programming Interface, Application Programming Interface)?

1. Like WEB development, you first need some relevant parameters. These parameters will be passed by the client, maybe GET or POST. This requires the development team to communicate with each other. Make an agreement or develop unified specifications.

2. With parameters, complete data processing according to application requirements, such as: task progress update, APP in-app purchase, end-of-game data submission, etc.

3. Data logic processing completed After that, return the relevant data needed by the client, such as: task status, in-app purchase results, player information, etc.

How to return the data to the client?

Direct output form, such as: JSON, XML, TEXT, etc.

4. After the client obtains the data you returned, it interacts with the user locally on the client

A simple API example written temporarily:

<?php
// 设置json格式
header(&#39;content-type:application/json;charset=utf-8&#39;);
$output = array();
$a = @$_GET[&#39;a&#39;] ? $_GET[&#39;a&#39;] : &#39;&#39;;
$uid = @$_GET[&#39;uid&#39;] ? $_GET[&#39;uid&#39;] : 0;
if (empty($a)) {
    $output = array(&#39;data&#39;=>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;);
}

Copy after login

For the client For example, directly call such an address:

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

Copy after login

In actual projects, we should pay attention to several things when developing APIs (for reference only):

1. There are many ways to implement multiple interfaces in a single file, such as: if..elseif.. or switch or dynamic method (that is, the form of accessing the function body of TP)

2. For data It is best to use json for the output. JSON has a very strong cross-platform nature. All major mainstream programming languages in the market support json parsing. JSON is gradually replacing xml and becoming the universal format for network data.

3. Interface security , be sure to add interface verification. For example, the client and server use unified encryption methods for different interfaces, and the server needs to verify each interface. This is to ensure that the interface is prevented from being maliciously refreshed or maliciously called by hackers, especially for large commercial applications.

4. For online APIs, you must ensure that all interfaces are normal and all error messages are closed => error_reporting(0). When outputting JSON, there cannot be any other output. Otherwise, the client will parse the data. Failure, direct Crash!

5. There is a certain difference between developing API and WEB. If it is WEB, the code may be wrong, which will not cause particularly serious errors. It may only cause data writing and query failure, or it may cause some problems in WEB. Some parts are misaligned or garbled. But if it’s an API, just Crash!

For more PHP related knowledge, please visit PHP Chinese website!

The above is the detailed content of How to write the interface in php project. For more information, please follow other related articles on the PHP Chinese website!