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配置示例：

ServerAdmin admin@

DocumentRoot "E:\wamp64\www\xApi\xApiManager\public" ServerName

ErrorLog "logs/.log"

CustomLog "logs/-access.log" common

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 已经支持多项目了