api文档接口管理项目实践操作
缘由
由于开发需要经常写接口的开发文档，但是由于自己写的是word文档，不方便前端开发人员的查阅
所以目标是搭建一个公共的管理项目，当然，我们想的是找到比较好的一些开源项目。毕竟不能重复造轮子（好像自己可以造似的，搞笑），我们希望的是自己搭建一个内部使用的平台，而不是使用他们自己提供的平台，以下是几个开源项目的总结：好不好你们自行评价
1：easydoc（文档简单，没有模板就不好用）
官网地址：easydoc
github地址: easydoc
对于安装文档，我只能说，我从未见过如此简单的文档
文档中心
建议看一下官方文档，如果看懂了，那就不需要在看以下的信息了（哈哈哈）
上传解压到 linux 服务器上
unzip easydoc-2.0.6-linux-amd64.zip easydoc206
cd easydoc206
进入到目录，我们可以看到 就一个文件（离谱）
如何查看安装成功，执行 easydoc -version
你可能会看到以下错误 bash: ./easydoc: Permission denied,这是是由于没有执行权限
执行 chmod 777 easydoc 就可以了，再次执行，就可以看到
[[email protected] easydoc]#
[[email protected] easydoc]# ./easydoc -version
EasyDoc 2.0.6
Author: Yumin Wu
Website: https://easydoc.089858.com
由于其他地方也要用，所以讲当前的目录加入到path路径下
修改 vi /etc/profile
然后 source /etc/profile 使其生效，此时不管你在哪儿都可以使用 easydoc -version命令
使用
官方文档就是简洁
easydoc -help 可以看到相关的命令，以下官网总结的
-init 初始化文档结构
-build 生成文档
-server 启动 web 服务(可以配合[或不配合]端口-port和路径-path一起使用，默认端口是 80 -port 80，默认路径是 dist 目录-path ./dist)
-emptydist 清空 dist 目录
-help 帮助文档
-version 查看 EasyDoc 版本
实践操作
mkdir workspace
cd workspace
执行 easydoc -init
会在目录下创建以下的目录结构
我们先启动一下看一下效果
easydoc -server
查看浏览器
这个查看的就是 src目录下的 index.html
总结
页面比较简单，但是如果没有模板的话，不怎么好用，以上
2:另一款 easydoc
效果图：
这个开源项目使用起来还是蛮简单的，官方文档也是蛮简单的
项目启动步骤
导入项目到IDE中（导入maven项目）
执行easydoc_ddl&data.sql中的脚本，创建数据库以及导入数据
运行EasydocSpringbootApplication.java
访问http://localhost:8081/
端口可在application-dev.properties中修改
登录用户：
admin/123456
admin2/123456
jim/123456 (只读权限)
简单介绍
注意：这个需要使用谷歌浏览器，其他浏览器可能登录不了
以下简单说一下功能：
页面提供了简单的目录和文档的增加，但是目录好像没有添加删除功能，仅提供文档的删除
文档的编写实现了markdown的语法格式
后台的代码格式还是蛮简单的
简单总结
可以进行二次开发
对于比较懒得人来说，不足可能就是不能创建多级目录，但是这个可以自己迭代，总体来说还行吧，如果没有多级目录的话，这个还是很方便的