## 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
* 安装完成后，若要测试接口权限相关信息，那么需要到后台配置对应账号的访问权限。
