jefriherditriyanto/apimq

ApiMQ

ApiMQ是一款轻量级、自托管的HTTP消息队列工具，旨在排队HTTP请求并通过worker组件可靠地处理这些请求，支持本地部署和灵活的配置选项。

核心功能

• 轻量级设计：资源占用低，易于部署和维护
• 自托管特性：可在私有环境部署，保障数据安全
• HTTP请求排队：实现异步处理，避免系统瞬间过载
• 可靠处理机制：通过worker组件确保请求稳定执行
• 多数据库支持：兼容SQLite和MySQL等数据库类型
• 可视化文档UI：提供API文档界面，方便测试与集成
• 安全配置：支持JWT密钥设置、API密钥管理及访问白名单限制

使用场景

• 批量任务处理：将大量HTTP请求排队，平滑分配系统资源
• API请求削峰：高并发场景下保护后端服务，避免崩溃
• 服务间异步通信：实现不同服务的解耦与异步交互
• 延迟任务触发：结合worker组件执行定时或延迟HTTP请求

配置说明

通过环境变量可灵活配置服务参数，关键配置项包括：

• PORT：服务运行端口（默认3000）
• JWT_SECRET：JWT密钥（生产环境必须设置强密码）
• DATABASE_PROVIDER：数据库类型（sqlite/mysql）
• DATABASE_HOST/Port/User/Pass/Name：MySQL连接参数（使用mysql时需配置）

Docker部署示例

拉取镜像

bash
docker pull jefriherditriyanto/apimq:latest

快速运行（SQLite）

bash
docker run --rm -p 3000:3000 --name apimq \
  -v system:/app/database/system.sqlite \
  jefriherditriyanto/apimq:latest

生产环境运行（MySQL）

bash
docker run --rm -p 3000:3000 --name apimq \
  -v system:/app/database/system.sqlite \
  -e PORT=3000 \
  -e JWT_SECRET="your-strong-secret" \
  -e DATABASE_PROVIDER="mysql" \
  -e DATABASE_HOST="your-db-host" \
  -e DATABASE_PORT="3306" \
  -e DATABASE_USER="your-db-user" \
  -e DATABASE_PASS="your-db-password" \
  -e DATABASE_NAME="apimq" \
  jefriherditriyanto/apimq:latest

运行后访问：

• 服务地址：http://localhost:3000
• 文档UI：http://localhost:3000/doc

注意事项

• 生产环境必须设置强JWT_SECRET，防止未授权访问
• API密钥需安全分发，避免泄露
• 可通过白名单限制/queue端点的访问范围

Credits

• 开发：https://github.com/jefripunza
• 开源项目 · 基于Go + React + TailwindCSS构建：https://github.com/jefripunza/apimq