【docker】一个非常适合IT团队的在线API文档、技术文档工具 | showdoc

1. 前言

官网：ShowDoc

ShowDoc是一款专为IT团队设计的在线API和技术文档工具。你可以使用Markdown语法编写API文档、数据字典、技术文档等。ShowDoc还支持从程序注释自动生成API文档，或通过RunApi客户端边调试接口边生成文档。

用途：

• API文档：快速编写和发布API文档，方便客户端调用数据。
• 数据字典：清晰描述数据库结构和字段释义。
• 说明文档：编写工具说明书或技术规范文档，供团队查阅。

主要功能：

• 分享与导出：支持响应式设计，可将文档分享到各平台，或导出成Word文件。
• 权限管理：提供公开和私密项目两种权限设置，项目创建者可自由转让项目。
• 项目成员：添加或删除项目成员，成员可编辑但不能转让或删除项目。
• 团队管理：便捷的团队协作功能。
• 编辑功能：采用Markdown编辑器，支持模板插入和历史版本恢复。
• 多平台支持：提供网页版、手机App版和电脑客户端版。
• 自动化：从代码注释中自动生成文档，并可搭配RunApi客户端调试接口。

2. 准备

在开始部署之前，你需要安装 docker 和 docker-compose。具体安装见：【docker】在服务器上安装 docker/docker-compose

你可以为服务器添加 1~2G 的 swap：手动添加 SWAP

3. 部署

官方的安装文档：Docker方式安装

原版官方镜像安装命令，新建文件夹：

代码语言：javascript复制

mkdir -p /root/data/docker_data/showdoc_data/html
cd /root/data/docker_data/showdoc_data
chmod  -R 777 /root/data/docker_data/showdoc_data

如果你是想把数据挂载到其他目录，比如说/data1，那么，可以在/data1目录下新建一个showdoc_data/目录，然后在根目录的新建一个软链接/showdoc_data到/data1/showdoc_data。这样既能保持跟官方教程推荐的路径一致，又能达到自定义存储的目的。

创建配置文件：

代码语言：javascript复制

vim docker-compose.yml

英文输入法下按 i 进入编辑模式后，粘贴：

代码语言：javascript复制

version: '3.8'

services:
  showdoc:
    image: star7th/showdoc
    container_name: showdoc
    user: root
    restart: always
    privileged: true
    ports:
      - "49999:80"
    volumes:
      - /showdoc_data/html:/var/www/html

按 esc 后，输入:wq 保存退出。运行：

代码语言：javascript复制

docker-compose up -d

4. 反向代理

你可以进行反向代理并开启 SSL，具体为你的域名 -> 服务器IP:49999，反代可以参考下面两篇文章：

【docker】反向代理神器 ——Nginx Proxy Manager 的安装

【docker】Nginx Proxy Manager 的使用

5. 使用

访问ip:49999进入配置页面：

我们选择中文，然后初始化成功。默认管理员账户密码是showdoc/123456。进入首页：

使用默认的用户名和密码就可以进入后台了：

6. 未完待续

api it 工具 客户端 数据

0 人点赞