forba/fabaseapi

Forba Base API 镜像文档

1. 镜像概述

Forba Base API 是一个预配置的Docker镜像，专为基于Forba框架的后端API服务设计。该镜像封装了Forba框架核心组件及运行时环境，提供标准化的API服务基础架构，简化开发流程并确保部署一致性。

2. 核心功能与特性

2.1 核心功能

• API路由管理：内置路由配置机制，支持RESTful API设计规范
• 请求处理：集成请求参数校验、身份认证及权限控制模块
• 响应格式化：统一API响应格式，支持JSON标准输出
• 服务集成：兼容主流数据库（MySQL、PostgreSQL）及缓存服务（Redis）

2.2 特性

• 轻量级：基于Alpine Linux构建，镜像体积小，资源占用低
• 可扩展：支持插件机制，可按需集成日志、监控等附加功能
• 易配置：通过环境变量实现灵活配置，无需修改代码即可调整服务参数
• 高可用：内置健康检查接口，支持容器编排平台的自动恢复机制

3. 使用场景与适用范围

3.1 适用场景

• 后端API服务开发与部署
• 微服务架构中的独立API服务节点
• 快速原型验证与演示环境搭建
• 企业级应用中的标准化API服务基础层

3.2 适用人群

• 后端开发工程师
• DevOps工程师（负责API服务部署与维护）
• 需要快速构建API服务的技术团队

4. 使用方法与配置说明

4.1 快速启动

使用以下命令启动基础API服务容器：

bash
docker run -d \
  --name forba-base-api \
  -p 8080:8080 \
  -e API_PORT=8080 \
  -e LOG_LEVEL=info \
  docker.xuanyuan.run/forba/base-api:latest

服务启动后，可通过 http://localhost:8080/health 访问健康检查接口，返回 {"status":"ok"} 表示服务正常运行。

4.2 环境变量配置

4.3 持久化配置

如需持久化存储配置文件或日志，可挂载本地目录：

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

4.4 Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3.8'
services:
  forba-api:
    image: docker.xuanyuan.run/forba/base-api:latest
    container_name: forba-base-api
    ports:
      - "8080:8080"
    environment:
      - API_PORT=8080
      - LOG_LEVEL=debug
      - DB_CONN_STR=mysql://root:password@mysql:3306/forba_db
      - REDIS_URL=redis://redis:6379
    volumes:
      - ./config:/app/config
      - ./logs:/app/logs
    depends_on:
      - mysql
      - redis

  mysql:
    image: docker.xuanyuan.run/mysql:8.0
    environment:
      - MYSQL_ROOT_PASSWORD=password
      - MYSQL_DATABASE=forba_db
    volumes:
      - mysql-data:/var/lib/mysql

  redis:
    image: docker.xuanyuan.run/redis:alpine
    volumes:
      - redis-data:/data

volumes:
  mysql-data:
  redis-data:

通过 docker-compose up -d 启动服务集群。

5. 注意事项

• 生产环境中建议设置 LOG_LEVEL=warn 或 error 以减少日志量
• 敏感配置（如数据库密码）建议通过Docker Secrets或环境变量加密工具管理
• 镜像版本需指定具体标签（如 v1.2.0）而非 latest，确保部署一致性
• 服务扩展时需通过负载均衡（如Nginx）分发请求，避免直接暴露多个容器实例