article
README
🚀 中央心智网关文档
中央心智网关借助大语言模型生成API配置文件,具备支持多种数据库连接的能力,并拥有一系列高级功能,能有效提升数据处理与交互的效率和安全性。
✨ 主要特性
数据发现与建模
- 📋 数据表自动识别:可识别PostgreSQL、Redshift等多种数据库中的表结构。
- 🔍 列类型推断:自动推断数值型、日期时间、字符串等数据类型。
- 🛡️ PII检测:识别敏感字段如信用卡号、社会安全码,并在生成API时进行脱敏处理。
安全特性
- 🔒 访问控制:支持基于IP白名单和JWT的认证授权机制。
- 🚫 速率限制:默认支持每秒请求限制(QPS),防止滥用攻击。
- 📝 审计日志:记录所有API调用,包括用户信息、操作类型和响应状态码。
高级功能
- 📡 协议支持:同时支持HTTP REST和MCP协议,可与Claude等工具无缝集成。
- 🙈 数据脱敏:对敏感字段自动应用脱敏规则,如掩码处理。
- 🗃️ 多版本支持:支持在同一配置文件中定义多个API版本。
🚀 快速开始
💻 代码运行示例
# 安装依赖
go mod download
# 运行网关
./gateway start --config gateway.yaml
🐳 Docker部署示例
# Docker Compose配置
version: '3'
services:
gateway:
build: .
ports:
- "8080:8080"
environment:
- GEMINI_API_KEY=yourkey
📚 详细文档
📋 API生成指南
步骤1:选择AI提供方
支持以下几种:
- OpenAI及兼容提供方
- Anthropic
- Amazon Bedrock
- Google Vertex AI (Anthropic)
- Google Gemini(免费层)
获取API密钥:
export GEMINI_API_KEY='yourkey'
步骤2:运行发现命令
./gateway discover \
--ai-provider gemini \
--connection-string "postgresql://neondb_owner:MY_PASSWORD@MY_HOST.neon.tech/neondb?sslmode=require" \
--prompt "Generate for me awesome readonly API"
步骤3:查看生成结果
INFO 🚀 API Discovery Process
INFO Step 1: Read configs
INFO ✅ Step 1 completed. Done.
INFO Step 2: Discover data
INFO Discovered Tables:
INFO - payment_dim: 3 columns, 39 rows
INFO - fact_table: 9 columns, 1000000 rows
INFO ✅ Step 2 completed. Done.
🚀 运行指南
🏠 本地运行
./gateway start --config gateway.yaml
🐋 Docker Compose部署
docker compose -f ./example/simple/docker-compose.yml up
🔌 MCP协议集成
在Claude配置文件中添加:
{
"mcpServers": {
"gateway": {
"command": "PATH_TO_GATEWAY_BINARY",
"args": ["start", "--config", "PATH_TO_GATEWAY_YAML_CONFIG", "mcp-stdio"]
}
}
}
🗺️ 路线图
📅 计划功能
- 📊 扩展数据库支持:Redshift、S3(Parquet格式)、Snowflake等。
- 🔐 增强安全性:引入细粒度访问控制和动态脱敏。
- ⚙️ 性能优化:提升复杂查询处理速度,降低延迟。
Scan to join WeChat group