xApi-Manager 接口管理平台操作手册

xApiManager操作手册
项目介绍
XAPI MANAGER -专业实用的开源接口管理平台，为程序开发者提供一个灵活，方便，快捷的API管理工具，让API管理变的更加清晰、明朗。

特点
全站基于Laravel 5.4 + Bootstrap + jQuery +layer3.0开发
开放源代码，开发者可以根据自己的需求自由使用和定制
让开发者更加专注于项目业务和逻辑的实现，及协同开发
支持多项目、多环境管理，支持消息通知及帮助中心
版本说明
当前最新版为v2.0, 后续我们将不断优化和改进，欢迎大家的指正和反馈
项目部署
1.安装环境
php版本>5.6.4, 推荐使用php7.0，效率大家都懂的
请检查这几个扩展是否安装和开启，php_curl，php_mbstring , php_openssl
Windows 下推荐：WampServer 3.0. 64bit（默认含有上述扩展并已开启）
Linux 环境下请自行部署Lamp、lnmp环境
注意：很多朋友在部署环境时没找到入口文件，laravel默认的入口文件是根目录下
public/index.php
请将项目路径指向根目录的public文件
Nginx配置示例：
server {
listen 80;
server_name ;
root /usr/share/nginx/html/xapi/public;
#charset koi8-r;
#access_log /var/log/nginx/log/host.access.log main;
#设置加载css flash txt js 图片等资源
location ~* ^.+\.(jpg|jpeg|gif|png|bmp|css|js|swf|txt)$ { access_log off;
break;
}
location / {
try_files $uri $uri/ /index.php?$query_string;
index index.php index.html index.htm;
}
#error_page 404 /404.html;
# redirect server error pages to the static page /50x.html
#
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root /usr/share/nginx/html;
}
#
location ~ \.php$ {
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; include fastcgi_params;
}
# deny access to .htaccess files, if Apache's document root
# concurs with nginx's one
#location ~ /\.ht {
# deny all;
#}
apache配置示例：
<VirtualHost *:80>
ServerAdmin admin@
DocumentRoot "E:\wamp64\www\xApi\xApiManager\public" ServerName
ErrorLog "logs/.log"
CustomLog "logs/-access.log" common
</VirtualHost>
2.一键安装及升级
针对很多用户反馈的v1.0安装问题，我们在v2.0采用了一键安装。

当您配置好nginx或apache后，直接访问您的域名（如：），会自动检查以下两步：
1.自动检测是否存在.env文件，如果不存在的话，自动复制根目录下的.env.example重
命名为.env文件（此时不用修改env文件的信息）。

2.自动检查是否安装数据库，没有安装的话直接跳转到安装页面，该页面会检查您是否开
启php_curl，php_mbstring , php_openssl这些扩展，如果没有开启会提示您开启。

符合条件后您可以输入数据库信息。

单击安装后会导入数据库文件，并将数据库信息写入.env 文件（避免了手动修改的麻烦）
注意，如果您之前安装了xApi Manager v1.0版本的话，更新代码后，请单击在线升级，升级过程会导入新表和修改表字段。

亲们，请一定要备份您的数据库，一定要备份、一定要备份，重要的事情说三遍。

升级后管理员用户请检查一下项目成员的权限。

3.常见问题汇总
如果您在部署过程中，遇到什么问题，您可以查看日志文件（如：/storage/logs/laravel-2017-09-12.log）或是加入QQ讨论群（623709829）进行反馈
xApi v2.0 常见的问题，欢迎大家给我们反馈，以便我们及时修复
●v1.0 版本时很多朋友在问注册页哪里去了，原本是想管理员集中统一创建用户。

但我
在实际使用时需要要依次录入开发、测试、访客的用户信息，很多人，当时我也很崩溃。

v2.0版本我们添加了注册页，用户注册后，管理员只需在用户管理中激活一下即可登录。

●v1.0 中用户遇到最多的另外一个问题是登录页验证码打不开（缺少php的php_fileinfo
扩展），v2.0版本我们优化了验证方式。

更轻松也更便捷
●另外一个反馈最多的就是多项目支持，目前v2.0 已经支持多项目了
以下是xApi v1.0 的常见问题
验证码打不开，此时日志文件会报错：
PHP Fileinfo extension must be installed/enabled to use Intervention Image
解决方案：php缺少扩展，安装php_fileinfo.dll 扩展即可（仅phpstudy集成工具会出这个问题）
2.待审核接口返回网络错误，此时日志文件报错：
Syntax error or access violation: 1140 Mixing of GROUP columns (MIN(),MAX(),COUNT(),...) with no GROUP columns is illegal if there is no GROUP BY clause
解决方案：把config/database.php的mysql中的strict改为false即可（该问题仅部分环境会出现）
操作说明
1.系统设置
亲们，安装完成后别忘了，进行核心数据的配置，但愿你不会忘！
核心配置即项目设置和系统环境配置：
1 . 单击系统环境配置后进入配置页面，默认开启了四个环境，请根据您的业务需求选择相应的环境。

环境域名即您的Api地址前缀，配置后您在查询接口详情时，xapi会自动获取相
应环境的域名生成，api地址。

2. 单击项目设置，配置项目信息及项目权限组
配置好后，xApi的更多功能就等着您去发现和使用2.分权管理
分权管理包括功能权限和数据权限，其中数据权限因为时间关系暂时没有开发完成，计划以后版本添加
功能权限：
3.接口分类
当前分类分为两级，您可以根据您的需要添加分类信息
项目部署后，接口分类中没有任何分类信息，请通过菜单栏添加分类(分类信息>>添加分类)，添加后点击接口分类便能看到分类信息。

通过菜单栏添加的分类，属于一级分类，您可以通过接口分类中的子分类添加二级分类。

接口列表搜索和添加Api时，都会用到二级分类，请提前添加。

权限
v2.0版本支持导出子分类接口列表到word文档，你可以自由修改word文档的接口信息。

（v1.0版本导出的是pdf）
4.接口信息
接口列表中支持通过二级分类名称的首字母查询该分类下的所有接口，当您的鼠标移到某个字母时，就会出现相应的子分类，单击该分类就能查询到相应的Api
接口添加时，不论当前Api环境是什么，都统一保存在测试环境下。

添加的Api都需要管理员审核，审核通过后才能发布到上一级环境中
注意：发布Api时，Api将同步到当前环境的上一级环境，Api同步的顺序依次是（测试环境>集成环境>预发布环境>线上环境）。

如果您当前是测试环境，Api将同步到集成环境，同步成功后，你可以在网站顶部切换到集成环境，便能看到同步的Api。

添加接口时，gateway地址和本地的接口地址可以一致，也可以不一致。

gateway地址用于app和web端调用，本地接口地址用于开发。

接口详情已优化支持json、jsonp、xml、html的显示和输出
5.各城市接口统计
我们在控制台模拟了一个统计各城市的Api请求量的实时地图，其中的数据是一些随机数。

如果您打算实现一个真实的各城市请求量，请在根目录下config/project.php中开发一个类似/Statistics/v1/area 的接口并替换该接口（返回字段参考该接口）。

另外我们在表mx_area中添加了中国的所有城市，方便您查询使用。