eoLinker-AMS开源版 部署指南

eoLinekr-AMS接口管理系统开源版本

注意：3.x版本与2.x版本并不兼容，因此无法直接由2.x升级到3.x，也无法通过覆盖代码的方式进行升级，切勿随意尝试以防数据丢失

如果需要进行数据的迁移，可以使用eoLinker接口管理系统中的【导出项目】功能
将项目导出为eoLinker专用格式（.export），然后在3.x版本中导入。
同时为了防止数据丢失，请在执行任何关键操作之前妥善备份数据库

一、环境要求

• PHP 5.5+ / PHP7+（推荐）
• Mysql 5.5+ / Mariadb 5.5+
• Nginx（推荐） / Apache
• 项目目录需要具有完全的读写权限（777），用于写入配置文件。安装完成之后可以设置另外设置目录权限
• PHP需要安装并启用mbstring以及curl模块，用于字符串处理以及接口测试功能

二、注意事项

• 3.x版本与2.x版本并不兼容，因此无法直接由2.x升级到3.x，也无法通过覆盖代码的方式进行升级，切勿随意尝试以防数据丢失；
• 如果需要进行数据的迁移，可以使用eoLinker接口管理系统中的【导出项目】功能：将项目导出为eoLinker专用格式（.export），然后在3.x版本中导入；
• 为了防止数据丢失，请在执行任何关键操作之前妥善备份数据库；

三、安装指南

从Github等途径获取开源版代码之后，目录结构如下：

其中：

• backend_resource：后端源码
• frontend_resource：前端源码（未压缩，使用Angular进行编写）
• release：安装包，可用于直接安装

打开release文件夹，找到最新版本的压缩包，解压到合适的PHP环境下，并且通过浏览器访问项目根目录。如果正常则会转到如下引导页面：

根据指引页面提示，输入相应信息并且通过环境监测后，即可安装成功。随后页面会跳转至用户注册页面。

开源版的使用操作与线上免费版基本同步，如有任何使用的问题请参考 线上版操作指南。

------------------------------------------------------------------------------------------

eoLinker API Management System（AMS）是一款帮助企业开发人员进行在线管理接口文档、进行自动化测试、团队协作的工具，它旨在提高企业项目的接口管理水平，提升开发速度并且降低运维成本。

eoLinker是目前业内领先、国内最大的在线API接口管理平台，提供自动生成API文档、API自动化测试、Mock测试、团队协作等功能，旨在解决由于前后端分离导致的开发效率低下问题。现已为Google、IBM、腾讯、中国联通、中国移动、华为、中外运、海尔、拉卡拉、神州优车、国美等近千家企业提供快速、专业、稳定的API管理服务。

eoLinker还是Google谷歌开发者联盟的战略合作企业，不定期举办线下交流分享活动促进国内API管理领域的发展；支持及拥抱开源，不断地开放各种强大的功能与全球开发者共享！

1、免费&开源：eoLinker拥有强大的免费产品，在过去的一年里面eoLinker已迭代超过300个版本，优化近千功能点，同时秉承开源精神，提供国际化的开源产品（支持中文简体、繁体以及英语），为广大的开发、测试以及管理人员提供全面、易用、专业的产品。

2、同类产品中最强大的API文档管理系统：支持目前HTTP/HTTPS协议以及所有主流请求方式，并且提供了强大的版本管理功能，可以随时随地回滚API信息；同时支持数据库管理、状态码管理、项目文档管理等常用管理功能。

3、代码自动生成文档：通过读取代码中的EOML（eoLinker标注语言）注解，eoLinker可以自动生成API文档，省去了重复录入的麻烦，无缝连接开发与管理工作。

4、API接口测试：支持文件、在线、跨域、自动化测试等功能。同时拥有参数构造器，可以对请求参数进行自动构造，加密、分割、随机字符串等功能一应俱全。配合测试用例可以非常方便地对比请求结果与模型，找出API可能出现的问题。

5、API自动化测试：eoLinker是目前全球唯一一款支持界面与代码双模式的自动化测试工具。在UI界面模式下，你不需要编写任何代码即可创建数据相互关联的API测试用例（比如注册-登录-检查登陆状况-退出登录）；同时你也可以通过编写Javascript代码来构造复杂的自动化测试场景。这些都极大地简化了开发测试人员的API测试工作，每次开发完成只需要一个键即可自动测试所有API并且生成测试报告，帮助了解项目API的健康状况。

6、API Mock测试：提供最强的Mock功能，支持MockJS，支持自动刷新返回结果以及多种返回的结果。同时还支持对API进行请求校验，当参数或值不符合预设的模板时能够及时找出问题所在。

7、支持文档分享和导出：你可以通过eoLinker在线生成接口文档，也可以导出成为HTML、PDF以及Word等，快速分享或发布API信息。

8、支持Postman、RAP、RestClint等数据导入：无需重新录入API信息，一键导入即可切换平台。

9、强大的团队协作功能：你可以通过URL快速邀请成员或者加入某个项目，eoLinker提供了全面的日志追踪以及权限管理功能。

10、拥有最全面的产品线：eoLinker除了拥有线上版本之外，还提供了免费开源版本、浏览器插件、PC端桌面程序等，可以满足企业所有的API管理需求。