Discuz Api 接口【X3.5】二次開發 - 在線手冊

admin

接口二次開發

本功能由PHP+MYSQL語言開發，無縫對接新秀網絡驗證系統，采用獨立入口文件、類文件、第三方類文件庫進行調用開發。所有功能實現及控制均采用api接口操作，數據輸出形式為JSON、XML兩種常見形式，達到毫秒級數據快速交換功能。 1、接口開發是結合新秀網絡驗證系統進行的二次開發，不能獨立使用； 2、接口開發遵循Discuz、新秀網絡驗證、PHP語言規范開發； 3、接口開發適用于新秀網絡驗證系統3.5ver1.3版本以后； 4、本功能與新秀網絡驗證系統、擴展框架系統，代碼相互獨立，但功能同時執行； 5、接口開發可使用Discuz內置函數、新秀網絡驗證內置函數、PHP函數。

適用環境：php版本>7.0、Mysql版本>5.5以上、Discuz版本>3.5。

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

接口開發常用函數

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

2、新秀網絡驗證數據庫對照表    /*新秀網絡驗證系統內部，所有數據庫表及說明*/

3、Discuz官方數據庫對照表  /*Discuz官方數據庫表，包括discuz、UCente數據庫字典。*/

4、Discuz基礎框架、類、函數    /*包含Discuz官方基礎框架、類、函數、方法使用說明。*/

5、新秀網絡基礎框架類、函數    /*包含新秀網絡驗證基礎框架、類、函數、方法使用說明。*/

二次接口開發示例

1、*

使 用 簡 介

1、接口開發演示文件下載

dev接口開發模版.zip (3.2 KB, 下載次數: 609) 2024-4-7 20:57 上傳 點擊文件名下載附件 【UTF8】

2、接口開發演示文件目錄說明

xinxiuvip_network \\新秀網絡驗證系統插件主目錄 —lib \\自定義類存放目錄 （用于開發者存放第三方類、自定義類，命名：lib_dev.php） —function \\自定義方法存放目錄 （用于開發者存放自定義開發接口類和方法） ——function_dev.php \\自定義方法類開發文件 （自定義開發接口方法類） —dev.inc.php \\自定義接口入口開發文件

3、如何安裝、開發、調試？

#1、下載演示文件后，上傳至新秀網絡驗證插件根目錄。discuz論壇插件根目錄 \source\plugin\xinxiuvip_network\ #2、使用PHP代碼編輯軟件，對入口文件 dev.inc.php 和 自定義方法類文件 function_dev.php 進行開發，注意：UTF8及GBK編碼問題。 #3、如需新增接口文件，請根據演示文件，修改 “dev” 為您想要的文件名，但不能與新秀框架插件內文件名沖突，且開發的接口方法，不能與新秀框架沖突。 #4、功能代碼開發完成，組裝調試接口： [PHP] 純文本查看 復制代碼 //根據演示文件中組裝url接口地址 demo35.xinxiuvip.com/plugin.php?id=xinxiuvip_network:dev&key=123456&action=dev_demo1&demo1=demo&demo2=demo [PHP] 純文本查看 復制代碼 //根據演示文件中接口訪問返回的結果 { "code": "200", "result": "OK", "count": 2, "data": { "demo1": "demo", "demo2": "demo" }, "sqltime": "0.00131s" }

dev.inc.php入口文件代碼實例

[PHP] 純文本查看 復制代碼 <?php /* 創建時間 2024-04-06 21:33:55 技術支持 QQ：3188639 微信號：xinxiuvip 官方網站 [url=http://m.5566wy.com/]http://m.5566wy.com/[/url] 獲取授權 [url=http://m.5566wy.com/plugin.php?id=xinxiuvip_license:accredit]http://m.5566wy.com/plugin.php?id=xinxiuvip_license:accredit[/url] 開發手冊 [url=http://m.5566wy.com/thread-529-1-1.html]http://m.5566wy.com/thread-529-1-1.html[/url] 嚴禁反編譯、逆向等任何形式的侵權行為，違者將追究法律責任！ */ #以下兩行代碼，用于開發環境下代碼錯誤提示，可根據提示信息進行代碼檢查，無誤后即可注釋掉！ //ini_set("display_errors", "on"); //error_reporting(E_ALL); #注釋結束 #防止游客直接輸入網址進行訪問，權限檢測，勿動！！！ if (! defined('IN_DISCUZ')) { exit('Access Denied'); } #注釋結束 #引入自定義開發類文件，此文件保存位置 'function/dev' 代表 function/function_dev.php 如需修改請按格式進行！ C::import('function/dev', 'plugin/xinxiuvip_network', false); $api = new function_dev();//實例化function_dev.php類操作，實例化后可用$api->調用function_dev.php中的類方法！ #注釋結束 #此處為入口文件，根據接口方法，調用對應類方法。 switch ($api->action) { //$api->action 獲取入口方法，勿動！！！ case 'dev_demo1': // 判斷是否是此方法，如果是則進入下一步！ $demo1 = xx_client::safe_check('demo1', true); //判斷參數傳輸，params為參數名稱，iscore為是否是必填項（true為必填，false為可空） $demo2 = xx_client::safe_check('demo2', false);//判斷參數傳輸，params為參數名稱，iscore為是否是必填項（true為必填，false為可空） $api->dev_demo1($demo1,$demo2);//調用function_dev.php實例化后類方法，根據類方法設置傳入參數。 break; #此處代碼根據接口開發需求，可以無限添加循環。 case 'dev_demo2': $demo1 = xx_client::safe_check('demo1', true); $demo2 = xx_client::safe_check('demo2', false); $api->dev_demo1($demo1,$demo2); break; #注釋結束 #此處代碼是判斷接口輸入是否正確。勿刪！！！ default: xx_client::json_output(400,'error010'); break; #注釋結束 } #注釋結束

function_dev.php自定義方法類代碼實例

[PHP] 純文本查看 復制代碼 <?php /* 創建時間 2024-04-06 21:33:55 技術支持 QQ：3188639 微信號：xinxiuvip 官方網站 [url=http://m.5566wy.com/]http://m.5566wy.com/[/url] 獲取授權 [url=http://m.5566wy.com/plugin.php?id=xinxiuvip_license:accredit]http://m.5566wy.com/plugin.php?id=xinxiuvip_license:accredit[/url] 開發手冊 [url=http://m.5566wy.com/thread-529-1-1.html]http://m.5566wy.com/thread-529-1-1.html[/url] 嚴禁反編譯、逆向等任何形式的侵權行為，違者將追究法律責任！ */ #以下兩行代碼，用于開發環境下代碼錯誤提示，可根據提示信息進行代碼檢查，無誤后即可注釋掉！ //ini_set("display_errors", "on"); //error_reporting(E_ALL); #注釋結束 #防止游客直接輸入網址進行訪問，權限檢測，勿動！！！ if (! defined('IN_DISCUZ')) { exit('Access Denied'); } #注釋結束 #引入核心系統類，勿刪！！！ C::import('class/client','plugin/xinxiuvip_network',false); require_once DISCUZ_ROOT.'./config/config_ucenter.php'; require_once DISCUZ_ROOT.'./uc_client/client.php'; #注釋結束 #如何引入自定義系統類？ #1、將自定義核心類、第三方核心類上傳至extend文件夾下； #2、通過 C::import 、 require_once 兩種引入形式引入第三方核心類； #3、在下方 public function dev_demo1($demo1,$demo2) 方法中實例化后使用 $new-> 進行調用。 #注釋結束 class function_dev extends class_client { public $action_all = array('dev_demo1');//所有接口必填，用逗號隔開！！！除以下key、adminkey所包含以外，未包含的接口都是通過token令牌進行訪問。 public $function_action_key = array('dev_demo1');//使用key密鑰訪問的接口 public $function_action_adminkey = array();//使用管理密鑰adminkey訪問的接口 public $config;//可自定義變量，在構造方法中設置變量值。 /** * 構造方法 __construct() 是在實例化對象時被自動調用 * 用途：可以用于初始化程序(可以給成員屬性賦值，也可以調用成員方法) */ public function __construct(){ parent::__construct(); $this->config = xx_G::xinxiuvip_network();//獲取新秀網絡插件配置信息 } #此處為標準類方法，可根據DISCUZ、新秀網絡驗證內置函數進行調用，也可使用PHP官方函數進行操作。 public function dev_demo1($demo1,$demo2){ #-具體DISCUZ內置函數、新秀網絡驗證內置函數、PHP函數，論壇相應帖子有專門介紹。 $data = array( //組合數組 'demo1' => $demo1, 'demo2' => $demo2 ); xx_client::json_output('200','',$data); // 新秀內置打印函數，打印結果，并結束程序。 #-具體DISCUZ內置函數、新秀網絡驗證內置函數、PHP函數，論壇相應帖子有專門介紹。 } #注釋結束 /** * 析構方法 __destruct() 是在對象被銷毀時自動調用 * 用途：可以進行資源的釋放操作或文件的關閉操作或信息保存操作 */ public function __destruct(){ } }

將接口添加到接口管理數據庫代碼實例

[SQL] 純文本查看 復制代碼 INSERT INTO `pre_xinxiuvip_network_actions` (`id`, `type`, `typekey`, `groups`, `name`, `actions`, `status`, `islogs`, `snum`, `hnum`, `dnum`, `nums`, `zjf`, `kjf`, `do`, `ips`, `url`, `ziduan`, `remarks`, `moment`) VALUES (NULL, '測試模塊', NULL, '', '測試名稱', 'dev_demo1', '0', '0', '0', '0', '0', '0', NULL, NULL, '0', '', 'http://m.5566wy.com/forum.php?mod=viewthread&tid=573', '', '', '');