Discuz Api 接口【X3.4】二次開發(fā) - 在線手冊(cè)

admin

接口二次開發(fā)

本功能由PHP+MYSQL語言開發(fā)，無縫對(duì)接新秀網(wǎng)絡(luò)驗(yàn)證系統(tǒng)，采用獨(dú)立入口文件、類文件、第三方類文件庫進(jìn)行調(diào)用開發(fā)。所有功能實(shí)現(xiàn)及控制均采用api接口操作，數(shù)據(jù)輸出形式為JSON、XML兩種常見形式，達(dá)到毫秒級(jí)數(shù)據(jù)快速交換功能。 1、接口開發(fā)是結(jié)合新秀網(wǎng)絡(luò)驗(yàn)證系統(tǒng)進(jìn)行的二次開發(fā)，不能獨(dú)立使用； 2、接口開發(fā)遵循Discuz、新秀網(wǎng)絡(luò)驗(yàn)證、PHP語言規(guī)范開發(fā)； 3、接口開發(fā)適用于新秀網(wǎng)絡(luò)驗(yàn)證系統(tǒng)ver5.7版本以后； 4、本功能與新秀網(wǎng)絡(luò)驗(yàn)證系統(tǒng)、擴(kuò)展框架系統(tǒng)，代碼相互獨(dú)立，但功能同時(shí)執(zhí)行； 5、接口開發(fā)可使用Discuz內(nèi)置函數(shù)、新秀網(wǎng)絡(luò)驗(yàn)證內(nèi)置函數(shù)、PHP函數(shù)。

適用環(huán)境：php版本>5.6、Mysql版本>5.5以上、Discuz版本>3.0。

= Discuz資料庫  = Discuz插件開發(fā)文檔  = 開發(fā)交流  =  BUG反饋  =  QQ客服：3188639  QQ交流群：281079920

接口開發(fā)常用函數(shù)

1、DB數(shù)據(jù)庫操作函數(shù)    /*常用MYSQL數(shù)據(jù)庫操作命令，增、減、改、查功能函數(shù)。*/

2、新秀網(wǎng)絡(luò)驗(yàn)證數(shù)據(jù)庫對(duì)照表    /*新秀網(wǎng)絡(luò)驗(yàn)證系統(tǒng)內(nèi)部，所有數(shù)據(jù)庫表及說明*/

3、Discuz官方數(shù)據(jù)庫對(duì)照表  /*Discuz官方數(shù)據(jù)庫表，包括discuz、UCente數(shù)據(jù)庫字典。*/

4、Discuz基礎(chǔ)框架、類、函數(shù)    /*包含Discuz官方基礎(chǔ)框架、類、函數(shù)、方法使用說明。*/

5、新秀網(wǎng)絡(luò)基礎(chǔ)框架類、函數(shù)    /*包含新秀網(wǎng)絡(luò)驗(yàn)證基礎(chǔ)框架、類、函數(shù)、方法使用說明。*/

二次接口開發(fā)示例

1、payjs在線充值系統(tǒng)-ver5.8-開源   /*系統(tǒng)內(nèi)置支付功能，可充值積分、時(shí)間、購買卡密！*/

使 用 簡(jiǎn) 介

1、接口開發(fā)演示文件下載

接口開發(fā)dev_demo文件-ver6.1以上.zip (3.66 KB, 下載次數(shù): 52) 2021-9-22 19:22 上傳 點(diǎn)擊文件名下載附件 新秀網(wǎng)絡(luò)驗(yàn)證接口二次開發(fā)演示文件 閱讀權(quán)限: 100 【UTF8】

2、接口開發(fā)演示文件目錄說明

xinxiu_network \\新秀網(wǎng)絡(luò)驗(yàn)證系統(tǒng)插件主目錄 —extend \\自定義類存放目錄 （用于開發(fā)者存放第三方類、自定義類） —function \\自定義方法存放目錄 （用于開發(fā)者存放自定義開發(fā)接口類和方法） ——function_dev.php \\自定義方法類開發(fā)文件 （自定義開發(fā)接口方法類） —dev.inc.php \\自定義接口入口開發(fā)文件

3、如何安裝、開發(fā)、調(diào)試？

#1、下載演示文件后，上傳至新秀網(wǎng)絡(luò)驗(yàn)證插件根目錄。discuz論壇插件根目錄 \source\plugin\xinxiu_network\ #2、使用PHP代碼編輯軟件，對(duì)入口文件 dev.inc.php 和 自定義方法類文件 function_dev.php 進(jìn)行開發(fā)，注意：UTF8及GBK編碼問題。 #3、如需新增接口文件，請(qǐng)根據(jù)演示文件，修改 “dev” 為您想要的文件名，但不能與新秀框架插件內(nèi)文件名沖突，且開發(fā)的接口方法，不能與新秀框架沖突。 #4、功能代碼開發(fā)完成，組裝調(diào)試接口： //根據(jù)演示文件中組裝url接口地址 http://demo.xinxiuvip.com/plugin.php?id=xinxiu_network:dev&key=123456&action=dev_demo1&demo1=100&demo2=200 復(fù)制代碼 //根據(jù)演示文件中接口訪問返回的結(jié)果 {         "code": "200",         "result": "OK",         "count": 2,         "data": {                 "demo1": "100",                 "demo2": "200"         },         "sqltime": "0.00773s" } 復(fù)制代碼

dev.inc.php入口文件代碼實(shí)例

[PHP] 純文本查看 復(fù)制代碼 <?php /* 技術(shù)支持 QQ：3188639 QQ交流群：281079920 官方網(wǎng)站 [url=http://m.5566wy.com/]http://m.5566wy.com/[/url] 獲取授權(quán) [url=http://m.5566wy.com/plugin.php?id=xinxiu_license:accredit]http://m.5566wy.com/plugin.php?id=xinxiu_license:accredit[/url] 接口開發(fā)手冊(cè) [url=http://m.5566wy.com/forum.php?mod=viewthread&tid=394]http://m.5566wy.com/forum.php?mod=viewthread&tid=394[/url] 嚴(yán)禁反編譯、逆向等任何形式的侵權(quán)行為，違者將追究法律責(zé)任！ */ #以下兩行代碼，用于開發(fā)環(huán)境下代碼錯(cuò)誤提示，可根據(jù)提示信息進(jìn)行代碼檢查，無誤后即可注釋掉！ //ini_set("display_errors", "on"); //error_reporting(E_ALL); #注釋結(jié)束 #防止游客直接輸入網(wǎng)址進(jìn)行訪問，權(quán)限檢測(cè)，勿動(dòng)！！！ if (! defined('IN_DISCUZ')) { exit('Access Denied'); } #注釋結(jié)束 #引入自定義開發(fā)類文件，此文件保存位置 'function/dev' 代表 function/function_dev.php 如需修改請(qǐng)按格式進(jìn)行！ C::import('function/dev', 'plugin/xinxiu_network', false); $api = new function_dev();//實(shí)例化function_dev.php類操作，實(shí)例化后可用$api->調(diào)用function_dev.php中的類方法！ #注釋結(jié)束 #此處為入口文件，根據(jù)接口方法，調(diào)用對(duì)應(yīng)類方法。 switch ($api->action) { //$api->action 獲取入口方法，勿動(dòng)！！！ case 'dev_demo1': // 判斷是否是此方法，如果是則進(jìn)入下一步！ $demo1 = $api->safe_check('demo1', true); //判斷參數(shù)傳輸，params為參數(shù)名稱，iscore為是否是必填項(xiàng)（true為必填，false為可空） $demo2 = $api->safe_check('demo2', false); //判斷參數(shù)傳輸，params為參數(shù)名稱，iscore為是否是必填項(xiàng)（true為必填，false為可空） $api->dev_demo1($demo1,$demo2);//調(diào)用function_dev.php實(shí)例化后類方法，根據(jù)類方法設(shè)置傳入?yún)?shù)。 break; #此處代碼根據(jù)接口開發(fā)需求，可以無限添加循環(huán)。 case 'dev_demo2': $demo1 = $api->safe_check('demo1', true); $demo2 = $api->safe_check('demo2', false); $api->dev_demo1($demo1,$demo2); break; #注釋結(jié)束 #此處代碼是判斷接口輸入是否正確。勿刪！！！ default: xx_client::json_output(400,'error010'); break; #注釋結(jié)束 } #注釋結(jié)束

function_dev.php自定義方法類代碼實(shí)例

[PHP] 純文本查看 復(fù)制代碼 <?php /* 技術(shù)支持 QQ：3188639 QQ交流群：281079920 官方網(wǎng)站 [url=http://m.5566wy.com/]http://m.5566wy.com/[/url] 獲取授權(quán) [url=http://m.5566wy.com/plugin.php?id=xinxiu_license:accredit]http://m.5566wy.com/plugin.php?id=xinxiu_license:accredit[/url] 接口開發(fā)手冊(cè) [url=http://m.5566wy.com/forum.php?mod=viewthread&tid=394]http://m.5566wy.com/forum.php?mod=viewthread&tid=394[/url] 嚴(yán)禁反編譯、逆向等任何形式的侵權(quán)行為，違者將追究法律責(zé)任！ */ #以下兩行代碼，用于開發(fā)環(huán)境下代碼錯(cuò)誤提示，可根據(jù)提示信息進(jìn)行代碼檢查，無誤后即可注釋掉！ //ini_set("display_errors", "on"); //error_reporting(E_ALL); #注釋結(jié)束 #防止游客直接輸入網(wǎng)址進(jìn)行訪問，權(quán)限檢測(cè)，勿動(dòng)！！！ if (! defined('IN_DISCUZ')) { exit('Access Denied'); } #注釋結(jié)束 #引入核心系統(tǒng)類，勿刪！！！ C::import('class/base','plugin/xinxiu_network',false); C::import('class/client','plugin/xinxiu_network',false); require_once DISCUZ_ROOT.'./config/config_ucenter.php'; require_once DISCUZ_ROOT.'./uc_client/client.php'; #注釋結(jié)束 #如何引入自定義系統(tǒng)類？ #1、將自定義核心類、第三方核心類上傳至extend文件夾下； #2、通過 C::import 、 require_once 兩種引入形式引入第三方核心類； #3、在下方 public function dev_demo1($demo1,$demo2) 方法中實(shí)例化后使用 $new-> 進(jìn)行調(diào)用。 #注釋結(jié)束 class function_dev extends class_base { public $action_all = array('dev_demo1'); //所有接口必填，用逗號(hào)隔開！！！除以下key、adminkey所包含以外，未包含的接口都是通過token令牌進(jìn)行訪問。 public $function_action_key = array('dev_demo1'); //使用key密鑰訪問的接口 public $function_action_adminkey = array(); //使用管理密鑰adminkey訪問的接口 /** * 構(gòu)造方法 __construct() 是在實(shí)例化對(duì)象時(shí)被自動(dòng)調(diào)用 * 用途：可以用于初始化程序(可以給成員屬性賦值，也可以調(diào)用成員方法) */ public function __construct(){ parent::__construct(); $this->config; //為新秀網(wǎng)絡(luò)驗(yàn)證插件配置信息，數(shù)組型； } #此處為標(biāo)準(zhǔn)類方法，可根據(jù)DISCUZ、新秀網(wǎng)絡(luò)驗(yàn)證內(nèi)置函數(shù)進(jìn)行調(diào)用，也可使用PHP官方函數(shù)進(jìn)行操作。 public function dev_demo1($demo1,$demo2){ #-具體DISCUZ內(nèi)置函數(shù)、新秀網(wǎng)絡(luò)驗(yàn)證內(nèi)置函數(shù)、PHP函數(shù)，論壇相應(yīng)帖子有專門介紹。 $data = array( //組合數(shù)組 'demo1' => $demo1, 'demo2' => $demo2 ); xx_client::json_output('200','',$data); // 新秀內(nèi)置打印函數(shù)，打印結(jié)果，并結(jié)束程序。 #-具體DISCUZ內(nèi)置函數(shù)、新秀網(wǎng)絡(luò)驗(yàn)證內(nèi)置函數(shù)、PHP函數(shù)，論壇相應(yīng)帖子有專門介紹。 } #注釋結(jié)束 /** * 析構(gòu)方法 __destruct() 是在對(duì)象被銷毀時(shí)自動(dòng)調(diào)用 * 用途：可以進(jìn)行資源的釋放操作或文件的關(guān)閉操作或信息保存操作 */ public function __destruct(){ /*#接口入庫，即可使用后臺(tái)“接口管理”進(jìn)行管理。 $data = array( 'id' =>10000, //自定義接口id，為了不與系統(tǒng)內(nèi)部沖突，請(qǐng)?jiān)O(shè)置10000以后。 'type' =>'某某模塊', //模塊分類 'name'=>'某某功能', //模塊名稱 'actions'=>'dev_demo1', //接口方法 'url'=>'http://m.5566wy.com/forum.php?mod=viewthread&tid=313' //接口文檔地址 ); DB::insert('xinxiu_network_actions',$data,true,false,true); */ } }