xApiManager 接口管理平台操作手册

xApiManager操作手册项目介绍XAPIMANAGER-专业实用开源接口管理平台，为程序开发者提供一个灵活，方便，快捷API管理工具，让API管理变愈加清楚、明朗。特点全站基于Laravel5.4+Bootstrap+jQuery+layer3.0开发开放源代码，开发者能够依照自己需求自由使用和定制让开发者愈加专注于项目业务和逻辑实现，及协同开发支持多项目、多环境管理，支持消息通知及帮助中心版本说明当前最新版为v2.0,后续我们将不停优化和改进，欢迎大家指正和反馈项目布署1.安装环境php版本>5.6.4,推荐使用php7.0，效率大家都懂请检验这几个扩展是否安装和开启，php_curl，php_mbstring,php_opensslWindows下推荐：WampServer3.0.64bit（默认含有上述扩展并已开启）Linux环境下请自行布署Lamp、lnmp环境注意：很多朋友在布署环境时没找到入口文件，laravel默认入口文件是根目录下public/index.php请将项目路径指向根目录public文件Nginx配置示例：server{listen

80;server_name

;root

/usr/share/nginx/html/xapi/public;#charsetkoi8-r;#access_log

/var/log/nginx/log/host.access.log

main;#设置加载cssflashtxtjs图片等资源location~*^.+\.(jpg|jpeg|gif|png|bmp|css|js|swf|txt)${access_logoff;

break;

}location/{

try_files$uri$uri//index.php?$query_string;indexindex.phpindex.htmlindex.htm;}

#error_page

404

/404.html;#redirectservererrorpagestothestaticpage/50x.html#error_page

500502503504

/50x.html;location=/50x.html{root

/usr/share/nginx/html;}#location~\.php${fastcgi_pass

:9000;fastcgi_index

index.php;fastcgi_param

SCRIPT_FILENAME

$document_root$fastcgi_script_name;include

fastcgi_params;}#denyaccessto.htaccessfiles,ifApache'sdocumentroot#concurswithnginx'sone##location~/\.ht{#

deny

all;#}apache配置示例：<VirtualHost*:80>ServerAdminDocumentRoot"E:\wamp64\www\xApi\xApiManager\public"ServerNErrorLog"logs/.com.log"CustomLog"logs/.com-access.log"common</VirtualHost>2.一键安装及升级针对很多用户反馈v1.0安装问题，我们在v2.0采取了一键安装。当您配置好nginx或apache后，直接访问您域名（如：），会自动检验以下两步：自动检测是否存在.env文件，假如不存在话，自动复制根目录下.env.example重命名为.env文件（此时不用修改env文件信息）。自动检验是否安装数据库，没有安装话直接跳转到安装页面，该页面会检验您是否开启php_curl，php_mbstring,php_openssl这些扩展，假如没有开启会提醒您开启。符合条件后您能够输入数据库信息。单击安装后会导入数据库文件，并将数据库信息写入.env文件（防止了手动修改麻烦）注意，假如您之前安装了xApiManagerv1.0版本话，更新代码后，请单击在线升级，升级过程会导入新表和修改表字段。亲们，请一定要备份您数据库，一定要备份、一定要备份，主要事情说三遍。升级后管理员用户请检验一下项目组员权限。3.常见问题汇总假如您在布署过程中，碰到什么问题，您能够查看日志文件（如：/storage/logs/laravel--09-12.log）或是加入QQ讨论群（）进行反馈xApiv2.0常见问题，欢迎大家给我们反馈，方便我们及时修复v1.0版本时很多朋友在问注册页哪里去了，原本是想管理员集中统一创建用户。但我在实际使用时需要要依次录入开发、测试、访客用户信息，很多人，当初我也很瓦解。v2.0版本我们添加了注册页，用户注册后，管理员只需在用户管理中激活一下即可登录。v1.0中用户碰到最多另外一个问题是登录页验证码打不开（缺乏phpphp_fileinfo扩展），v2.0版本我们优化了验证方式。更轻松也更便捷另外一个反馈最多就是多项目支持，现在v2.0已经支持多项目了以下是xApiv1.0常见问题验证码打不开，此时日志文件会报错：PHPFileinfoextensionmustbeinstalled/enabledtouseInterventionImage处理方案：php缺乏扩展，安装php_fileinfo.dll扩展即可（仅phpstudy集成工具会出这个问题）2.待审核接口返回网络错误，此时日志文件报错：Syntaxerrororaccessviolation:1140MixingofGROUPcolumns(MIN(),MAX(),COUNT(),...)withnoGROUPcolumnsisillegalifthereisnoGROUPBYclause处理方案：把config/database.phpmysql中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端调用，当地接口地址用于开发。接口