💝💝💝欢迎来到我的博客，很高兴能够在这里和您见面！希望您在这里可以感受到一份轻松愉快的氛围，不仅可以获得有趣的内容和知识，也可以畅所欲言、分享您的想法和见解。
- 推荐:kwan 的首页,持续学习,不断总结,共同进步,活到老学到老
- 导航
非常期待和您一起在这个小小的网络世界里共同探索、学习和成长。💝💝💝 ✨✨ 欢迎订阅本专栏 ✨✨
博客目录
随着技术的发展，API 作为服务连接的桥梁，变得越来越重要。One API 是一种流行的 API 管理平台，能够帮助我们更好地管理、监控和扩展 API 服务。
一、前置知识
在进入具体操作之前，我们需要了解一些背景知识：
- Docker：Docker 是一个开源的容器化平台，它允许开发者将应用程序及其依赖项打包到一个轻量级的容器中，从而使应用程序可以在任何地方一致地运行。
- Docker Compose ：Docker Compose 是一个用于定义和运行多容器 Docker 应用的工具。通过 Docker Compose 文件（通常命名为
docker-compose.yml），可以在一个文件中定义多个服务，并通过一条命令启动这些服务。 - One API：One API 是一个 API 网关平台，它能够帮助开发人员更轻松地管理 API 请求，提供统一的 API 接口、请求路由以及安全管理。
二、使用 Docker Compose 部署 One API
在 Docker Compose 中，我们可以定义 One API 服务和其相关的配置。以下是一个典型的 docker-compose.yml 配置：
yml
one-api:
container_name: one-api
image: one-api:latest
restart: always
command: --log-dir /app/logs
ports:
- "3000:3000"
volumes:
- ./volumes/one-api/data:/data
- ./volumes/one-api/logs:/app/logs
- ./volumes/data-gym-cache:/tmp/data-gym-cache
environment:
- SQL_DSN=root:test2024@tcp(111.18.9.111:3306)/oneapi
- SESSION_SECRET=random_string
- TZ=Asia/Shanghai
depends_on:
mysql:
condition: service_healthy
healthcheck:
test:
[
"CMD-SHELL",
"wget -q -O - http://localhost:3000/api/status | grep -o '\"success\":\\s*true' | awk -F: '{print $2}'",
]
interval: 30s
timeout: 10s
retries: 3以上 docker-compose.yml 文件定义了一个名为 one-api 的服务，并设置了其依赖、端口、环境变量等配置项。下面我们详细解析该配置文件的各部分内容。
-
container_name : 设置容器名称为
one-api，方便通过名字快速识别和管理容器。 -
image : 指定了容器使用的镜像
one-api:latest，即 One API 的最新版本。 -
restart : 设置为
always，意味着无论容器退出的原因是什么，Docker 都会自动重启容器，以确保服务的持续可用性。 -
command : 通过命令
--log-dir /app/logs，将日志目录指定为/app/logs。 -
ports : 将主机的
3000端口映射到容器的3000端口，这样我们可以通过http://localhost:3000访问 One API 服务。 -
volumes: 定义了多个数据卷，以便持久化存储数据和日志：
./volumes/one-api/data:/data：将本地./volumes/one-api/data目录挂载到容器中的/data目录，用于存储持久化数据。./volumes/one-api/logs:/app/logs：将日志文件挂载到本地./volumes/one-api/logs，便于日志管理和分析。./volumes/data-gym-cache:/tmp/data-gym-cache：将缓存数据存放在./volumes/data-gym-cache。
-
environment: 定义了几个环境变量：
SQL_DSN：用于连接数据库的 DSN 配置，格式为user:password@tcp(host:port)/dbname。SESSION_SECRET：设置会话密钥，用于加密和验证会话。TZ：时区设置为Asia/Shanghai，确保日志时间等信息符合本地时区。
-
depends_on : 该配置用于声明服务之间的依赖关系。例如，One API 依赖于 MySQL 数据库，
depends_on配置确保 MySQL 数据库在 One API 启动前处于健康状态。 -
healthcheck: 定义了健康检查的命令和时间间隔：
test：健康检查的命令，使用wget请求 One API 的状态接口，检测返回结果中是否包含"success": true。interval、timeout和retries分别设置健康检查的间隔、超时和重试次数。
启动服务
运行以下命令启动服务：
bash
docker-compose up -d该命令会在后台启动服务，并自动根据 docker-compose.yml 文件中的配置，完成 One API 容器的初始化和启动。
三、使用 Docker Run 命令直接运行 One API 容器
如果不想使用 Docker Compose，我们还可以使用 docker run 命令来直接启动 One API 容器：
bash
docker run -d \
--name one-api \
--restart always \
-p 3000:3000 \
-v $(pwd)/volumes/one-api/data:/data \
-v $(pwd)/volumes/one-api/logs:/app/logs \
-v $(pwd)/volumes/data-gym-cache:/tmp/data-gym-cache \
-e SQL_DSN=root:test2024@tcp(111.18.9.111:3306)/oneapi \
-e SESSION_SECRET=random_string \
-e TZ=Asia/Shanghai \
--health-cmd="wget -q -O - http://localhost:3000/api/status | grep -o '\"success\":\\s*true' | awk -F: '{print $2}'" \
--health-interval=30s \
--health-timeout=10s \
--health-retries=3 \
one-api:latest \
--log-dir /app/logs命令参数解析
- -d：表示在后台运行容器。
- --name ：指定容器的名称为
one-api。 - --restart always：设置容器自动重启。
- -p 3000:3000：映射端口，与 Docker Compose 配置一致。
- -v：挂载卷，与 Docker Compose 中的卷配置一致。
- -e：设置环境变量。
- --health-cmd 、--health-interval 、--health-timeout 和 --health-retries：健康检查配置。
觉得有用的话点个赞
👍🏻呗。❤️❤️❤️本人水平有限，如有纰漏，欢迎各位大佬评论批评指正！😄😄😄
💘💘💘如果觉得这篇文对你有帮助的话，也请给个点赞、收藏下吧，非常感谢!👍 👍 👍
🔥🔥🔥Stay Hungry Stay Foolish 道阻且长,行则将至,让我们一起加油吧！🌙🌙🌙
