steamcmd/api

SteamCMD API Docker 镜像文档

镜像概述和主要用途

SteamCMD API 是一个用于 steamcmd app_info 的只读 API 接口。官方 API 可通过 api.steamcmd.net 访问，其文档可在 [***] 找到。本镜像提供了 API 的容器化部署方案，包含 API 代码和 uvicorn 工具以响应 Web 请求。

核心功能和特性

• 提供 Web 服务（FastAPI）和 Job 服务（Celery）两种组件
• 支持 Redis 缓存机制，提高响应性能
• 可通过环境变量或 .env 文件灵活配置
• 容器化部署，易于集成到各类环境
• 自动构建和版本控制，确保获取最新稳定版本

使用场景和适用范围

• 需要自托管 SteamCMD API 的环境
• 开发和测试依赖 steamcmd app_info 的应用程序
• 需要定制化配置 SteamCMD API 的企业或个人用户
• Kubernetes 集群部署（参考官方平台配置）

详细的使用方法和配置说明

镜像获取

bash
# 获取最新版本
docker pull docker.xuanyuan.run/steamcmd/api:latest

# 获取特定版本
docker pull docker.xuanyuan.run/steamcmd/api:1.10.0

基本运行

bash
docker run -p 8000:8000 -d docker.xuanyuan.run/steamcmd/api:latest

完整部署方案

API 由两个服务组成：Web 服务和 Job 服务，以及 Redis 缓存。Job 服务和 Redis 缓存都是可选的，但如果要运行 Job 服务，则两者都需要。

Docker Compose 部署示例

yaml
version: '3'

services:
  web:
    image: docker.xuanyuan.run/steamcmd/api:latest
    ports:
      - "8000:8000"
    environment:
      - CACHE=True
      - CACHE_TYPE=redis
      - CACHE_EXPIRATION=120
      - REDIS_HOST=redis
      - REDIS_PORT=6379
    depends_on:
      - redis
    restart: always

  job:
    image: docker.xuanyuan.run/steamcmd/api:latest
    command: celery -A job worker --loglevel=info --concurrency=2 --beat
    environment:
      - CACHE=True
      - CACHE_TYPE=redis
      - CACHE_EXPIRATION=120
      - REDIS_HOST=redis
      - REDIS_PORT=6379
    depends_on:
      - redis
    restart: always

  redis:
    image: docker.xuanyuan.run/redis:alpine
    ports:
      - "6379:6379"
    volumes:
      - redis_data:/data
    restart: always

volumes:
  redis_data:

配置说明

环境变量配置

可以通过环境变量或 .env 文件配置 API。所有设置都是可选的，但选择缓存类型时，需要设置相应的缓存设置。

.env 文件配置示例

shell
# 通用配置
VERSION=1.0.0

# 缓存配置
CACHE=True
CACHE_TYPE=redis
CACHE_EXPIRATION=120

# Redis 配置
REDIS_HOST="your.redis.host.example.com"
REDIS_PORT=6379
REDIS_PASSWORD="YourRedisP@ssword!"

# 或者使用 Redis 连接 URL
# REDIS_URL="redis://YourUsername:YourRedisP@ssword!@your.redis.host.example.com:6379"

# 日志配置
LOG_LEVEL=info

开发环境设置

如需在本地开发和运行 API，可按照以下步骤操作：

1. 创建并激活 Python 虚拟环境：

bash
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

2. 运行 Web 服务（FastAPI）：

bash
source .venv/bin/activate
cd src/
fastapi dev web.py

服务将在 http://localhost:8000 上运行。

3. 运行 Job 服务（Celery）：

bash
source .venv/bin/activate
cd src/
celery -A job worker --loglevel=info --concurrency=2 --beat

4. 代码格式化（使用 Black）：

bash
pip install black
black src

相关资源

• 官方 API: api.steamcmd.net
• 官方文档: [***]
• 源代码: https://github.com/steamcmd/api
• 部署配置: https://github.com/steamcmd/platform