Linux部署eolinker(API文档管理工具)

1.什么是API文档

API文档是一份可交付的技术内容，其中包含有关如何有效使用和集成API的说明。这也是一本简单明了的参考手册，编写了使用API所需的所有信息，以及有关功能、返回类型、参数等详细信息，并提供了教程和示例支持。

API文档通常由常规的内容创建和维护工具以及文本编辑器完成的。例如 Swagger、eolinker规范之类的API描述格式已经自动化了文档处理过程，从而使团队可以更轻松地生成和维护API。

2.为什么需要使用文档API

在API生命周期的所有阶段中，文档可能是增长最快的领域。对于围绕文档的工具生态系统尤其如此。注意到这一趋势很有趣，因为从传统上讲，文档是开发人员在编写代码时很少关注的东西。实际上，实现代码比编写良好的文档要容易得多。

提高用户使用率 拥有良好的API文档的一个重要原因是，它改善了开发人员使用API的体验，这与API的采用直接相关。如果API文档正确无误，那么更多的人将很容易在提供的服务中发现价值，从而可以更好地发展和采用。

节省支持时间和成本 好的文档还可以减少新用户（无论是内部开发人员还是外部合作伙伴）的培训时间。糟糕的文档或者没有文档意味着更多用户依赖于团队培训来理解如何使用API。 相反，当你在用户使用API之前先试用API，并且配备详细的api文档，将为团队节省大量时间来回复电子邮件和电话。

易于维护 文档可带来良好的产品维护。它可以帮助内部团队了解资源、方法及其相关请求和响应的详细信息，从而可以更快地进行维护和更新。

3.服务器环境要求

Mysql5.5以上
Nginx（推荐） / Apache

4.下载资源

下载链接提取码:43ln

5.创建数据库执行sql

创建一个名为eolinker_os的数据库，运行eolinker.sql文件
执行成功结果如下

6.部署

在服务器的/opt目录下创建eolinker文件夹并将把刚刚下载下来的项目中为eolinker_os_release_4_0.zip的文件压缩包上传至服务器解压

unzip eolinker_os_release_4_0.zip 

进入解压后的文件夹的/config文件夹下，编辑setting.properties文件

vim setting.properties

点击i进入编辑模式，修改端口号，dbUser和dbPassword填入连接数据库的账户名和密码，dbUrl填入自己的数据库连接地址。
修改完成后点击ESC退出编辑莫斯 输入:wq保存并退出
服务器上注意开放对应端口

7.启动

nohup java -jar eolinker_os-4.0.jar &

启动成功后访问 http://jar所在IP地址:端口号/eolinker_os/index.html

过程中如果有小伙伴遇到问题或者有好的见解可以及时联系