jambonz/api-server Docker 镜像 - 轩辕镜像

jambonz-api-server

Jambones平台的REST API服务器，负责处理平台API请求，支持账户、应用等资源管理，依赖MySQL存储长期数据及Redis缓存，需通过环境变量配置核心参数。

核心功能与特性

• 提供REST API接口，支持账户、应用等资源的CRUD操作
• 集成JWT认证机制，通过密钥签署令牌保障API安全访问
• 支持请求速率限制，可配置限制窗口及窗口内最大请求数
• 与MySQL数据库交互，存储账户、应用等长期数据
• 依赖Redis进行缓存，提升数据访问性能
• 可选集成HOMER系统，支持呼叫记录查看
• 支持Kubernetes环境部署，可配置与feature server的服务发现

使用场景与适用范围

适用于Jambones平台的API服务部署，作为平台核心组件，供前端或第三方服务调用，实现平台资源管理及业务逻辑处理。

配置说明

环境变量配置

数据库依赖

需使用MySQL数据库存储长期数据（账户、应用等），通过以下脚本初始化数据库：

• jambones-sql.sql：创建数据库schema
• seed-production-database-open-source.sql：初始化数据库（含账户、权限、API密钥等初始数据）
• create-admin-user.sql：创建管理员用户（初始密码"admin"，首次登录需强制修改）

注意：因依赖npm mysql包，MySQL数据库必须配置为使用SQL native authentication。

使用方法与部署示例

Docker运行示例

通过以下命令启动容器，替换环境变量值为实际配置：

bash
docker run -d \
  -e JWT_SECRET=your_jwt_secret \
  -e ENCRYPTION_SECRET=your_encryption_secret \
  -e JAMBONES_MYSQL_HOST=mysql-host \
  -e JAMBONES_MYSQL_USER=mysql-user \
  -e JAMBONES_MYSQL_PASSWORD=mysql-password \
  -e JAMBONES_MYSQL_DATABASE=jambones \
  -e JAMBONES_REDIS_HOST=redis-host \
  -e JAMBONES_TIME_SERIES_HOST=influxdb-host \
  -p 3000:3000 \
  jambonz/jambonz-api-server

自定义端口示例（如4000）：

bash
docker run -d \
  -e JWT_SECRET=your_jwt_secret \
  -e ENCRYPTION_SECRET=your_encryption_secret \
  -e JAMBONES_MYSQL_HOST=mysql-host \
  -e JAMBONES_MYSQL_USER=mysql-user \
  -e JAMBONES_MYSQL_PASSWORD=mysql-password \
  -e JAMBONES_MYSQL_DATABASE=jambones \
  -e JAMBONES_REDIS_HOST=redis-host \
  -e JAMBONES_TIME_SERIES_HOST=influxdb-host \
  -e HTTP_PORT=4000 \
  -p 4000:4000 \
  jambonz/jambonz-api-server

测试已部署服务

服务启动后，可通过Swagger UI测试API，访问地址：http://<your-ip>:3000/swagger。访问需Bearer认证，可执行db/create-admin-token.sql生成认证令牌。