如:
https://localhost/openUser.php?act=get_user_list&type=json
在這里openUser.php相當(dāng)于一個(gè)接口,其中g(shù)et_user_list 是一個(gè)API(獲取用戶(hù)列表),講求返回的數(shù)據(jù)類(lèi)型為JSON格式。
你只需要在你PHP代碼中執(zhí)行這條鏈接他就會(huì)返回。
GET方式的直接使用
$file_contents = file_get_content('https://localhost/openUser.php?act=get_user_list&type=json')
POST方式得用下面的(需要開(kāi)啟PHP curl支持)。
$url = 'https://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 中編寫(xiě)接口
一、先簡(jiǎn)單回答兩個(gè)問(wèn)題:
1、PHP 可以開(kāi)發(fā)客戶(hù)端?
答:不可以,因?yàn)镻HP是腳本語(yǔ)言,是負(fù)責(zé)完成 B/S架構(gòu) 或 C/S架構(gòu) 的S部分,即:服務(wù)端的開(kāi)發(fā)。(別去糾結(jié) GTK、WinBinder)
2、為什么選擇 PHP 作為開(kāi)發(fā)服務(wù)端的首選?
答:跨平臺(tái)(可以運(yùn)行在UNIX、LINUX、WINDOWS、Mac OS下)、低消耗(PHP消耗相當(dāng)少的系統(tǒng)資源)、運(yùn)行效率高(相對(duì)而言)、MySQL的完美搭檔,本身是免費(fèi)開(kāi)源的,......
二、如何使用 PHP 開(kāi)發(fā) API(Application Programming Interface,應(yīng)用程序編程接口) 呢?
做過(guò) API 的人應(yīng)該了解,其實(shí)開(kāi)發(fā) API 比開(kāi)發(fā) WEB 更簡(jiǎn)潔,但可能邏輯更復(fù)雜,因?yàn)?API 其實(shí)就是數(shù)據(jù)輸出,不用呈現(xiàn)頁(yè)面,所以也就不存在 MVC(API 只有 M 和 C),
1、和 WEB 開(kāi)發(fā)一樣,首先需要一些相關(guān)的參數(shù),這些參數(shù),都會(huì)由客戶(hù)端傳過(guò)來(lái),也許是 GET 也許是 POST,這個(gè)需要開(kāi)發(fā)團(tuán)隊(duì)相互之間約定好,或者制定統(tǒng)一規(guī)范。
2、有了參數(shù),根據(jù)應(yīng)用需求,完成數(shù)據(jù)處理,例如:任務(wù)進(jìn)度更新、APP內(nèi)購(gòu)、一局游戲結(jié)束數(shù)據(jù)提交等等
3、數(shù)據(jù)邏輯處理完之后,返回客戶(hù)端所需要用到的相關(guān)數(shù)據(jù),例如:任務(wù)狀態(tài)、內(nèi)購(gòu)結(jié)果、玩家信息等等
數(shù)據(jù)怎么返給客戶(hù)端?
直接輸出的形式,如:JSON、XML、TEXT 等等。
4、客戶(hù)端獲取到你返回的數(shù)據(jù)后,在客戶(hù)端本地和用戶(hù)進(jìn)行交互
臨時(shí)寫(xiě)的一個(gè)簡(jiǎn)單 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') { //檢查用戶(hù) if ($uid == 0) { $output = array('data'=>NULL, 'info'=>'The uid is null!', 'code'=>-401); exit(json_encode($output)); } //假設(shè) $mysql 是數(shù)據(jù)庫(kù) $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)); } //查詢(xún)數(shù)據(jù)庫(kù) $userInfo = $mysql[$uid]; //輸出數(shù)據(jù) $output = array( 'data' => array( 'userInfo' => $userInfo, 'isLogin' => true,//是否首次登陸 'unread' => 4,//未讀消息數(shù)量 'untask' => 3,//未完成任務(wù) ), 'info' => 'Here is the message which, commonly used in popup window', //消息提示,客戶(hù)端常會(huì)用此作為給彈窗信息。 'code' => 200, //成功與失敗的代碼,一般都是正數(shù)或者負(fù)數(shù) ); exit(json_encode($output)); } elseif ($a == 'get_games_result') { //... die('您正在調(diào) get_games_result 接口!'); } elseif ($a == 'upload_avatars') { //.... die('您正在調(diào) upload_avatars 接口!'); }
點(diǎn)擊測(cè)試(對(duì)于客戶(hù)端而言,也是直接調(diào)用這樣的地址):
https://www.ezhi.net/api/test/index.php
https://www.ezhi.net/api/test/index.php?a=get_users
https://www.ezhi.net/api/test/index.php?a=get_users&uid=10001
https://www.ezhi.net/api/test/index.php?a=get_users&uid=10002
https://www.ezhi.net/api/test/index.php?a=get_users&uid=10003
三、實(shí)際項(xiàng)目中,我們?cè)陂_(kāi)發(fā) API 應(yīng)該注意的幾個(gè)事項(xiàng)(僅供參考):
1、單文件實(shí)現(xiàn)多接口的形式有很多種,例如:if..elseif.. 或 switch 或 動(dòng)態(tài)方法 (也就是TP的這種訪(fǎng)問(wèn)函數(shù)體的形式)
2、對(duì)于數(shù)據(jù)的輸出最好用json,json具有相當(dāng)強(qiáng)大的跨平臺(tái)性,市場(chǎng)上各大主流編程語(yǔ)言都支持json解析,json正在逐步取代xml,成為網(wǎng)絡(luò)數(shù)據(jù)的通用格式
3、接口安全,一定要增加接口驗(yàn)證。例如,客戶(hù)端和服務(wù)端針對(duì)不同接口統(tǒng)一做好加密方式,服務(wù)端在對(duì)于每次接口需要都要進(jìn)行驗(yàn)證。以保證防止接口被惡意刷新或黑客惡意調(diào)用,尤其是大型商業(yè)應(yīng)用。
4、對(duì)于線(xiàn)上的 API 必須保證所有接口正常且關(guān)閉所有的錯(cuò)誤信息 => error_reporting(0),在輸出JSON 時(shí),不能有任何其它輸出,否則,客戶(hù)端將解析數(shù)據(jù)失敗,直接 Crash!
5、開(kāi)發(fā) API 和 WEB 有一定的區(qū)別,如果是 WEB 的話(huà),可能代碼出錯(cuò)了,不會(huì)導(dǎo)致特別嚴(yán)重的錯(cuò)誤,也許只是導(dǎo)致數(shù)據(jù)寫(xiě)入和查詢(xún)失敗,也許導(dǎo)致 WEB 的某個(gè)部分錯(cuò)位或亂碼。但如果是 API,直接 Crash!
6、做接口開(kāi)發(fā),不建議使用框架開(kāi)發(fā),原因概括起來(lái)有兩點(diǎn)(其實(shí)我有點(diǎn)冒風(fēng)險(xiǎn)的,本人也是 TPer 一枚,畢竟這是TP的官網(wǎng)):
1)客戶(hù)端一般對(duì)服務(wù)端的響應(yīng)速度有極高要求,因此,使用最原生態(tài)的 PHP 完成接口開(kāi)發(fā),是最高效的,假如用到了框架,還需要加載各種不需要多余的文件,就好比夏天穿了件冬天的衣服。試想,你在玩手機(jī)的時(shí)候,使用一個(gè)應(yīng)用隨便一個(gè)操作,等半天才有動(dòng)靜,你受的了嗎?
2)就是上面第4點(diǎn)提到的,框架對(duì)于WEB開(kāi)發(fā),是件很幸福的事,但對(duì)于 API 而言,你實(shí)在不敢想象它會(huì)給你出什么岔子!最后你將痛苦不堪~~因?yàn)楹芏嗫蚣芏际菫?WEB 誕生的(我也很期待有一天能看到專(zhuān)門(mén)為開(kāi)發(fā) API 而生的框架或者擴(kuò)展)
這個(gè)也有人糾結(jié),接口效率與穩(wěn)定性,還得看編碼的人,有的人可能寫(xiě)的還不如框架跑的快,也有人覺(jué)得用框架沒(méi)什么問(wèn)題,這里只是建議,關(guān)鍵看自己的實(shí)際情況,同時(shí)建議代碼上線(xiàn)前壓測(cè)一下
說(shuō)到這,不得不說(shuō)扯一下,騰訊微博淘寶等開(kāi)放平臺(tái)。其實(shí)那些開(kāi)放平臺(tái),所謂的開(kāi)放,就是給你提供一個(gè)這樣的接口,你根據(jù)他們提供的技術(shù)文檔,按他們制定的格式和要求,調(diào)它們提供的接口文件(一般都是返回JSON或者XML),你就可以獲取到他們的相關(guān)信息,例如:QQ用戶(hù)基本信息、淘寶店鋪、商品消息等等。然后在根據(jù)這些消息,在你的應(yīng)用里完成交互。
其實(shí),ajax 也是調(diào)用 API 的接口
APP接口本身不難,跟寫(xiě)普通網(wǎng)站一樣,不過(guò)是在控制器中賦值給HTML頁(yè)面的值變成了一個(gè)輸出json數(shù)據(jù)的接口,如下面:
public function jiekou(){//查詢(xún) $User = M('User'); $list = $User->select();//查詢(xún)數(shù)據(jù) $return['list'] = $list; echo json($return);//接口返回的json數(shù)據(jù)了 }
微信掃碼
關(guān)注PHP中文網(wǎng)服務(wù)號(hào)
QQ掃碼
加入技術(shù)交流群
Copyright 2014-2025 http://ipnx.cn/ All Rights Reserved | php.cn | 湘ICP備2023035733號(hào)