Docker-Compose怎么部署Yapi

Yapi 是一个高效、易用、功能强大的 API 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。通过 Docker-Compose 部署 Yapi，可以简化环境配置和依赖管理，使得部署过程更加便捷和可重复。本文将详细介绍如何使用 Docker-Compose 部署 Yapi。

1. 准备工作

在开始部署之前，确保你的系统已经安装了 Docker 和 Docker-Compose。如果尚未安装，可以参考以下步骤进行安装。

1.1 安装 Docker

# 更新包索引
sudo apt-get update

# 安装必要的依赖包
sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common

# 添加 Docker 的官方 GPG 密钥
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

# 添加 Docker 的稳定版仓库
sudo add-apt-repository \
   "deb [arch=amd64] https://download.docker.com/linux/ubuntu \
   $(lsb_release -cs) \
   stable"

# 更新包索引
sudo apt-get update

# 安装 Docker CE
sudo apt-get install docker-ce docker-ce-cli containerd.io

# 验证 Docker 是否安装成功
sudo docker --version

1.2 安装 Docker-Compose

# 下载 Docker-Compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

# 赋予可执行权限
sudo chmod +x /usr/local/bin/docker-compose

# 验证 Docker-Compose 是否安装成功
docker-compose --version

2. 创建 Docker-Compose 文件

接下来，我们需要创建一个 docker-compose.yml 文件来定义 Yapi 的服务。这个文件将包含 Yapi 和 MongoDB 的配置。

version: '3'

services:
  mongo:
    image: mongo:4.2
    container_name: yapi-mongo
    volumes:
      - ./data/db:/data/db
    ports:
      - "27017:27017"
    restart: always

  yapi:
    image: jayfong/yapi:latest
    container_name: yapi
    depends_on:
      - mongo
    ports:
      - "3000:3000"
    environment:
      - YAPI_ADMIN_ACCOUNT=admin@yapi.com
      - YAPI_ADMIN_PASSWORD=123456
      - YAPI_CLOSE_REGISTER=true
      - YAPI_DB_SERVERNAME=mongo
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapi
    volumes:
      - ./data/yapi:/yapi
    restart: always

2.1 配置文件说明

• mongo: 使用 MongoDB 4.2 镜像作为 Yapi 的数据库服务。数据将持久化到 ./data/db 目录。
• yapi: 使用 jayfong/yapi 镜像作为 Yapi 的服务。Yapi 将监听 3000 端口，并通过环境变量配置管理员账户、数据库连接等信息。

3. 启动 Yapi 服务

在 docker-compose.yml 文件所在的目录下，执行以下命令启动 Yapi 服务：

docker-compose up -d

3.1 验证服务状态

使用以下命令查看服务状态：

docker-compose ps

如果一切正常，你应该会看到类似以下的输出：

   Name                  Command               State           Ports         
-------------------------------------------------------------------------
yapi        docker-entrypoint.sh node /yapi ...   Up      0.0.0.0:3000->3000/tcp
yapi-mongo  docker-entrypoint.sh mongod          Up      0.0.0.0:27017->27017/tcp

4. 访问 Yapi

在浏览器中访问 http://localhost:3000，你将看到 Yapi 的登录页面。使用在 docker-compose.yml 中配置的管理员账户（admin@yapi.com）和密码（123456）登录。

4.1 初始化 Yapi

首次登录后，Yapi 会提示你进行初始化配置。按照提示填写相关信息，完成初始化。

5. 管理 Yapi 服务

5.1 停止服务

要停止 Yapi 服务，可以使用以下命令：

docker-compose down

5.2 重启服务

要重启 Yapi 服务，可以使用以下命令：

docker-compose restart

5.3 查看日志

要查看 Yapi 的日志，可以使用以下命令：

docker-compose logs -f yapi

6. 数据备份与恢复

6.1 备份数据

Yapi 的数据存储在 MongoDB 中，因此备份 MongoDB 的数据即可。可以使用以下命令备份数据：

docker exec -t yapi-mongo mongodump --out /data/db/backup

6.2 恢复数据

要恢复数据，可以使用以下命令：

docker exec -t yapi-mongo mongorestore /data/db/backup

7. 总结

通过 Docker-Compose 部署 Yapi，可以大大简化部署过程，并且便于管理和维护。本文详细介绍了如何使用 Docker-Compose 部署 Yapi，并提供了相关的配置和管理命令。希望本文能帮助你顺利部署和使用 Yapi。

如果你在部署过程中遇到任何问题，可以参考 Yapi 的官方文档或社区支持。祝你使用愉快！