## 1. 安裝步驟
* 下載 APIEx 壓縮包,或者 克隆項目后,自己手動壓縮,注意,壓縮時,要求項目必須處于壓縮包的一級目錄下,不能在外部再包裹一層文件夾。至此,一個 APIEx 離線插件包就完成了。
* 按照 fastadmin 框架手冊說明,安裝 并 運行 fastadmin 框架后,進入后臺,點擊左側目錄 **插件管理** ,在右側插件列表上方,點擊 **離線安裝** ,選擇 APIEx 離線插件包進行安裝即可。
* 安裝完成后,需要在 \application\config.php 配置文件 中,對應路由管理的配置信息中,加入 APIEx 專用路由配置,如下代碼效果。
```
// 路由配置文件(支持配置多個)
'route_config_file' => ['route', 'apiload'],
//若使用 fastadmin V1.0.0.20200506_beta 以后的版本,則需要開啟域名部署,才能開啟路由功能
'url_domain_deploy'??????=>?true,
```
* 可以訪問如下信息,測試接口擴展插件是否成功安裝。
* 測試一:
* 測試地址:http://www.xxxxxxx.com/api/apiexdemo/noneedlogin
* 若返回如下示例值,則證明 api 模塊下的 apiroute.php(api根路由文件)生效 。
~~~
{
"code": 1,
"msg": "Successful apiex routing request",
"time": "1571646806",
"data": null
}
~~~
* 測試二:
* 測試地址:http://www.xxxxxxx.com/api/apiexdemo/noneedlogin?version=api_1.0.0
* 注意:這里 version=api_1.0.0 參數是用來說明**對應版本的路由配置文件**地址的,若用 version='api_1.0.0' 形式請求,則有可能會受到 單引號 影響,使得后臺解析錯誤。
* 若返回如下示例值,則證明對應 版本 1.0.0 下的 apiroute.php(版本api路由文件)生效 。
~~~
{
"code": 1,
"msg": "Successful apiex routing request",
"time": "1571646806",
"data": null
}
~~~
* 錯誤說明:
* 若出現如下返回值,證明接口邏輯生效,但是請求的路由信息不存在
~~~
{
"code": 404,
"msg": "Routing information does not exist",
"time": "1571647481"
}
~~~
* 此時,需要到 \application\apiload.php 文件中,進行參數bug調試。
* 在需要 version 參數 的接口中,很大的可能是參數 version 值錯誤。
* 若此處調試時,獲取到的參數信息正常,則再去找對應路由配置文件和控制器信息是否出錯。
## 2. 相關下載地址:
* fastadmin框架文檔:[https://doc.fastadmin.net/docs/index.html](https://doc.fastadmin.net/docs/index.html)
* APIEx插件碼云地址:[https://gitee.com/index103000/fastadmin\_addons\_apiex](https://gitee.com/index103000/fastadmin_addons_apiex)
## 3. 注意事項:
#### APIEx插件在安裝時,會安裝一個示例接口,推薦在測試完成后,刪除示例相關的接口信息。
* 示例接口文件路徑如下:\application\api\controller\apiexdemo
* apidemo 為示例 api 控制器目錄,在安裝 APIEx 插件時,會自動安裝此示例,此示例可用于測試是否可以正常使用接口。
* 另外,對應的示例路由信息配置的對應路徑如下:
+ \application\api\apiroute.php
+ \application\api\version\api\1.0.0\apiroute.php
* 安裝完成后,若要測試接口權限相關信息,那么需要到后臺配置對應賬號的訪問權限。