使用mindoc搭建接口文档管理系统

在开发app的过程中，虽然只是自己一个人负责前后端开发，但是发现没有接口文档还确实是不方便，确实需要一个接口文档管理系统。又不想用网上的系统，那就自己搭建一个吧。

选的是mindoc，mindoc的前身是smartwiki，smartwiki是php语言写的，大约五六年前用过，感觉很不错，简洁明了，可惜后来作者弃用了php版本，改用go语言又开发了一套，也就是现在的mindoc。在2021年mindoc的作者由于精力问题，已经把它贡献出来了，现在由mindoc-org负责维护。

先看看最终效果吧：

但是感觉这个系统好像不怎么火，今天把它的最新版本v2.1版本部署在自己的服务器上了，始终感觉作者把开发语言从php换成了go，是一个错误的选择。根据官方文档的部署，大体很简单，还是还是有几个小问题。简单记录一下吧。

官方网站：https://www.iminho.me/

github地址：https://github.com/mindoc-org/mindoc

记录下安装过程中需要注意的几个问题吧。

1. 版本选择

可以看到有两个linux版本，两个windows版本，分别支持32位系统和64位系统，最后两个是源码包，只是打包的格式不同而已。我这里安装的是linux版本，所以只说linux这两个版本的区别。

• mindoc_linux_amd64.zip linux, gcc版本编译，运行依赖系统glibc(CentOS不建议用这个)
• mindoc_linux_musl_amd64.zip linux, musl-gcc编译，运行不依赖系统glibc(CentOS推荐用这个)
• mindoc_windows_amd64.7z windows 64位
• mindoc_windows_386.7z windows 32位

2、app.conf配置

文档上说请将刚才解压目录下conf/app.conf.example重命名为app.conf，然后同时配置下面节点，但是下载解压后，conf目录里面就已经有app.conf文件了，而且关于数据库配置那里写法，也和官方文档上面有点不一样，咱直接把配置文件里面的注释掉，把官方的配置拷贝过来改一改就行了。

3、关于端口和访问地址

官方文档是显示启动端口是8181，但是下载的v2.1版本里面的app.conf配置文件上面的端口是8182，如果使用了nginx做反向代理的话，注意把端口配置成一样就行。

访问地址这里也要注意，下载过来的app.conf里面默认配置了这句

#系统完整URL(http://doc.iminho.me),如果该项不设置，会从请求头中获取地址。
# baseurl="${MINDOC_BASE_URL}"
baseurl="http://47.104.104.132:8182"

最后面这句baseurl很明显是开发人员自己的地址，要把它注释掉或者改成你自己的。

4、安装

执行下面命令即可

./mindoc_linux_amd64 install

安装过程会自动初始化数据库，并创建一个超级管理员账号：admin，密码：123456 

5、启动

官方文档的启动命令

#修改可执行权限
chmod +x mindoc_linux_amd64

#启动程序
./mindoc_linux_amd64

这样启动能正常访问，但是有一个问题，这是一个前台进程，当把窗口关闭后，程序就停止运行了，所以需要把它改成后台进行运行：

nohup ./mindoc_linux_musl_amd64 &