来到公司两个多月的时间,一直想给公司搭建一套Api接口文档的应用,之前的开发人员一直在使用第三方的东西,而且还有各种各样的限制

需求

1、开源

2、可控

3、简洁

选定showdoc

选定showdock主要是看中了他的markdown语法,因为目前我公司的gitlab已经支持了markdown来编辑UML

showdoc安装

1、gitlab地址

2、官网地址

docker安装

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 原版官方镜像安装命令(中国大陆用户不建议直接使用原版镜像,可以用后面的加速镜像)
docker pull star7th/showdoc
# 中国大陆镜像安装命令(安装后记得执行docker tag命令以进行重命名)
docker pull registry.docker-cn.com/star7th/showdoc
docker tag registry.docker-cn.com/star7th/showdoc:latest star7th/showdoc:latest
##后续命令无论使用官方镜像还是加速镜像都需要执行
#新建存放showdoc数据的目录
mkdir /showdoc_data
mkdir /showdoc_data/html
chmod 777 -R /showdoc_data
#启动showdoc容器。启动完了后别忘记后面还有转移数据的步骤。
docker run -d --name showdoc -p 4999:80 -v /showdoc_data/html:/var/www/html/ star7th/showdoc
#转移数据。执行这里的时候留意命令行界面有没有权限禁止的错误提示。
#如果有,则检查权限,或者安全限制(比如说可能selinux会禁止docker进程写文件)
docker exec showdoc \cp -fr /showdoc_data/html/ /var/www/
# 权限
chmod 777 -R /showdoc_data

直接安装

1、直接从gitlab下载源码

2、配置nginx到根目录即可

错误

1、showdoc已经不再支持mysql,所以建议各位不要再用

2、关于各种权限的问题,详细资料可点击常见问题