前段时间打算恢复一下我的API,那么就有了一个小问题:该用什么工具编写API文档呢?
于是在GitHub遨游了一会,找到了一个工具——ShowDoc

这玩意可以用来搭建很多类型的文档,也支持团队协作。总之就看你怎么用了,他的文档页面也挺美观的:

一般来说,你可以直接使用它提供的在线服务:https://www.showdoc.com.cn,但如果你比较注重隐私安全和搭建公开的API文档,那还是自部署比较好一些,所以下面来讲一下如何部署。注意:请确保服务器已有Docker环境

第一步:拉取镜像

docker pull star7th/showdoc:latest

第二步:新建存放showdoc数据的目录并赋予其权限

mkdir -p /showdoc_data/html
chmod  -R 777 /showdoc_data

目录位置可变,但要注意与下面启动容器的路径保持一致。

第三步:启动容器

docker run -d --name showdoc --user=root --privileged=true -p 4999:80 \
-v /showdoc_data/html:/var/www/html/ star7th/showdoc

注意:容器端口`80`不可更改!

启动容器后,访问`yourip:4999`即可。

接下来,享受使用此工具编写文档吧??

其他的小Tips

在使用下来后,你会发现,若直接访问主页会显示介绍页面,但这对于API文档是不友好的,因此,你可以在后台管理修改:

然后访问主页就会发现他会自己跳转过去了,但这期间仍会闪一下介绍页,可以考虑一下去删除这个介绍页的代码。

参考文档

ShowDoc官方文档