kepper/bw-api

Beethovens Werkstatt API 镜像

镜像概述和主要用途

本镜像专为Beethovens Werkstatt的API仓库设计，旨在提供标准化、隔离的容器环境，简化其API服务的部署、运行和扩展流程，确保服务在不同环境中具备一致的执行行为。

核心功能和特性

• 环境标准化：统一API服务运行环境，消除"在我机器上能运行"的环境依赖问题
• 运行隔离：通过容器化技术隔离API服务与宿主环境及其他应用，提升安全性
• 部署简化：支持一键启动，降低部署复杂度，适合集成到自动化部署流程
• 版本控制：通过镜像标签管理不同API版本，便于版本回滚和并行测试

使用场景和适用范围

• 开发环境：本地开发和调试Beethovens Werkstatt API功能
• 测试环境：自动化测试、集成测试中的API服务部署
• 生产环境：稳定运行API服务，对外提供接口服务
• CI/CD流程：作为持续集成/持续部署流程中的标准化运行单元

使用方法和配置说明

基本运行命令

通过以下命令启动API服务容器：

bash
docker run -d --name beethoven-api -p 8080:8080 beethoven-werkstatt/api:latest

环境变量配置

根据API服务需求，可通过-e参数注入环境变量（具体变量需参考API仓库文档）：

bash
docker run -d --name beethoven-api \
  -p 8080:8080 \
  -e API_PORT=8080 \
  -e LOG_LEVEL=info \
  -e DB_CONNECTION_STRING="postgresql://user:pass@db:5432/dbname" \
  beethoven-werkstatt/api:latest

数据持久化配置

如需持久化配置文件或日志，可通过-v参数挂载宿主机目录：

bash
docker run -d --name beethoven-api \
  -p 8080:8080 \
  -v ./config:/app/config \  # 挂载配置文件目录
  -v ./logs:/app/logs \      # 挂载日志目录
  beethoven-werkstatt/api:latest

Docker Compose 集成示例

创建docker-compose.yml文件实现多服务协同部署：

yaml
version: '3.8'
services:
  api:
    image: beethoven-werkstatt/api:latest
    container_name: beethoven-api
    ports:
      - "8080:8080"
    environment:
      - API_PORT=8080
      - DB_HOST=db
      - DB_PORT=5432
    volumes:
      - api_config:/app/config
      - api_logs:/app/logs
    depends_on:
      - db
    restart: unless-stopped

  db:
    image: postgres:14
    container_name: beethoven-db
    environment:
      - POSTGRES_USER=api_user
      - POSTGRES_PASSWORD=secure_password
      - POSTGRES_DB=api_db
    volumes:
      - db_data:/var/lib/postgresql/data

volumes:
  api_config:
  api_logs:
  db_data:

注意事项

• 端口映射需根据API实际监听端口调整（示例中使用8080）
• 环境变量和挂载需求需以API仓库官方文档为准
• 生产环境建议配置资源限制（--memory、--cpus参数）和健康检查
• 镜像标签（:latest）建议替换为具体版本号以确保部署一致性