forked from xiaohei/taiji-pda-v0
9.4 KiB
9.4 KiB
Taiji AI PAD 前端 API 接口状态文档
更新时间: 2025年1月
前端项目: taiji-pad-v0
后端服务:
- MCP Server:
http://localhost:8002 - Data Ingestion:
http://localhost:8001
📊 总体状态
| 模块 | 接口数量 | 状态 |
|---|---|---|
| 认证模块 | 6 | ✅ 全部已实现 |
| 用户侧平台 | 14 | ✅ 全部已实现 |
| 渠道合作伙伴 | 8 | ✅ 全部已实现 |
| 超级管理员 | 12 | ✅ 全部已实现 |
| 供应商管理 | 6 | ✅ 全部已实现 |
| Data Ingestion | 12 | ✅ 全部已实现 |
| MCP Server 核心 | 7 | ✅ 全部已实现 |
| 监控 API | 5 | ✅ 全部已实现 |
| WebSocket | 1 | ✅ 已实现 |
| 总计 | 71 | ✅ 全部已实现 |
✅ API 接口清单
1. 认证模块 API (/api/auth)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 用户登录 | POST | /api/auth/login |
✅ | 支持多角色登录 |
| 用户登出 | POST | /api/auth/logout |
✅ | 清除token |
| 刷新Token | POST | /api/auth/refresh |
✅ | 刷新访问令牌 |
| 修改密码 | PUT | /api/auth/password |
✅ | 修改用户密码 |
| 获取API密钥信息 | GET | /api/auth/keys/info |
✅ | 获取当前用户API密钥 |
| 重新生成API密钥 | POST | /api/auth/keys/regenerate |
✅ | 重新生成API密钥 |
2. 用户侧平台 API (/api/user)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 获取仪表板统计 | GET | /api/user/dashboard/stats |
✅ | 概览数据 |
| 获取Agent活动数据 | GET | /api/user/agents/activity |
✅ | 支持7d/30d/90d周期 |
| 选择网关类型 | POST | /api/user/gateway/select |
✅ | MCP/A2A/API |
| 创建网关API | POST | /api/user/gateway/api/create |
✅ | 创建自定义API |
| 获取网关API列表 | GET | /api/user/gateway/apis |
✅ | 列表查询 |
| 获取网关监控数据 | GET | /api/user/gateway/monitoring |
✅ | 监控信息 |
| 生成工具 | POST | /api/user/tools/generate |
✅ | 工具生成 |
| 创建数据模板 | POST | /api/user/data-templates/create |
✅ | JSON API/云存储 |
| 获取平台Agent列表 | GET | /api/user/agents/platform |
✅ | 平台Agent |
| 部署Agent | POST | /api/user/agents/deploy |
✅ | Agent部署 |
| 创建工作流 | POST | /api/user/workflows/create |
✅ | 最多3节点 |
| 获取余额信息 | GET | /api/user/billing/balance |
✅ | 余额查询 |
| 充值余额 | POST | /api/user/billing/recharge |
✅ | 支付宝/微信/卡 |
| 获取计费历史 | GET | /api/user/billing/history |
✅ | 支持导出 |
3. 渠道合作伙伴 API (/api/channel)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 获取租户列表 | GET | /api/channel/tenants |
✅ | 渠道下租户 |
| 创建租户 | POST | /api/channel/tenants/create |
✅ | 创建新租户 |
| 分配租户资源 | PUT | /api/channel/tenants/{id}/resources |
✅ | Agent/模型资源 |
| 更新租户计费设置 | PUT | /api/channel/tenants/{id}/billing |
✅ | 订阅级别/折扣 |
| 为租户充值 | POST | /api/channel/tenants/{id}/recharge |
✅ | 充值操作 |
| 设置租户授信额度 | PUT | /api/channel/tenants/{id}/credit |
✅ | 授信额度 |
| 申请资源 | POST | /api/channel/resources/apply |
✅ | 模型/Agent申请 |
| 获取渠道计费统计 | GET | /api/channel/billing/stats |
✅ | 支持导出 |
4. 超级管理员 API (/api/admin)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 获取平台统计 | GET | /api/admin/dashboard/stats |
✅ | 平台总览 |
| 创建管理员 | POST | /api/admin/admins/create |
✅ | 计费/运营管理员 |
| 获取渠道列表 | GET | /api/admin/channels |
✅ | 所有渠道 |
| 创建渠道 | POST | /api/admin/channels/create |
✅ | 新建渠道 |
| 管理渠道资源 | PUT | /api/admin/channels/{id}/resources |
✅ | 统一资源管理 |
| 获取所有申请 | GET | /api/admin/channels/applications |
✅ | 申请列表 |
| 审批申请 | PUT | /api/admin/channels/applications/{id}/review |
✅ | 批准/拒绝 |
| 获取模型供应商 | GET | /api/admin/resources/models |
✅ | 模型供应商列表 |
| 获取Agent资源 | GET | /api/admin/resources/agents |
✅ | Agent资源列表 |
| 删除Agent资源 | DELETE | /api/admin/resources/agents/{id} |
✅ | 删除Agent |
| 监控Agent健康 | GET | /api/admin/monitoring/agents |
✅ | Agent监控 |
| 获取计费概览 | GET | /api/admin/billing/overview |
✅ | 三维度计费 |
5. 供应商管理 API (/api/providers)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 获取模型供应商列表 | GET | /api/providers/models |
✅ | 供应商列表 |
| 创建模型供应商 | POST | /api/providers/models/create |
✅ | 新建供应商 |
| 获取供应商详情 | GET | /api/providers/models/{id} |
✅ | 详情查询 |
| 更新供应商配置 | PUT | /api/providers/models/{id} |
✅ | 更新配置 |
| 删除供应商 | DELETE | /api/providers/models/{id} |
✅ | 删除供应商 |
| 测试供应商连接 | POST | /api/providers/models/{id}/test |
✅ | 连接测试 |
6. Data Ingestion 服务 API (:8001)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 健康检查 | GET | /health |
✅ | 服务状态 |
| 同步RapidAPI | POST | /rapidapi/sync |
✅ | 后台同步 |
| 测试RapidAPI | POST | /rapidapi/test |
✅ | 端点测试 |
| 解析OpenAPI | POST | /openapi/parse |
✅ | OpenAPI解析 |
| APILLAMA处理 | POST | /apillama/process |
✅ | API文档处理 |
| 生成工具定义 | POST | /tools/generate |
✅ | 工具生成 |
| 获取工具列表 | GET | /tools |
✅ | 工具查询 |
| 获取工具定义 | GET | /tools/{name} |
✅ | 工具详情 |
| 删除工具 | DELETE | /tools/{name} |
✅ | 工具删除 |
| 获取统计信息 | GET | /stats |
✅ | 统计数据 |
| 清除缓存 | POST | /cache/clear |
✅ | 清理缓存 |
| Prometheus Metrics | GET | /metrics |
✅ | 监控指标 |
7. MCP Server 服务 API (:8002)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 健康检查 | GET | /health |
✅ | 服务状态 |
| 注册Agent | POST | /agents |
✅ | 新建Agent |
| 获取Agent列表 | GET | /agents |
✅ | Agent列表 |
| 获取Agent详情 | GET | /agents/{id} |
✅ | Agent详情 |
| 执行Agent工具 | POST | /agents/{id}/execute |
✅ | 工具执行 |
| 获取工具列表 | GET | /tools |
✅ | MCP工具列表 |
| Prometheus Metrics | GET | /metrics |
✅ | 监控指标 |
8. MCP 监控 API (/api/v1/monitoring)
| 接口 | 方法 | 路径 | 状态 | 说明 |
|---|---|---|---|---|
| 获取系统性能指标 | GET | /api/v1/monitoring/metrics |
✅ | CPU/内存/磁盘 |
| 获取服务统计 | GET | /api/v1/monitoring/stats |
✅ | 按服务聚合 |
| 获取性能趋势 | GET | /api/v1/monitoring/trends |
✅ | 时间区间趋势 |
| 获取系统告警 | GET | /api/v1/monitoring/alerts |
✅ | 告警列表 |
| 获取监控仪表盘 | GET | /api/v1/monitoring/dashboard |
✅ | 聚合数据 |
9. WebSocket API
| 接口 | 路径 | 状态 | 说明 |
|---|---|---|---|
| Agent WebSocket | ws://localhost:8002/ws/{agent_id} |
✅ | 实时通信 |
🧹 前端假数据清理记录
已删除以下硬编码的假数据,前端现在仅使用 API 返回的真实数据:
1. agent-factory/page.tsx
- ❌ 删除
defaultPlatformAgents数组(包含6个假Agent:天气查询、数据分析、文档处理、邮件管理、API集成、数据库操作) - ✅ 页面现在仅显示从
/api/user/agents/platform获取的真实数据 - ✅ 无数据时显示空状态提示
2. model-gateway/page.tsx
- ❌ 删除
defaultFrameworks数组中的假统计数据(endpoints: 8/5/6, usage: 42%/28%/30%) - ✅ 保留网关类型定义(MCP/A2A/API)作为系统固定选项(非假数据)
- ✅ 移除了"网关使用分布"假图表
3. orchestration/page.tsx
- ❌ 删除
defaultAvailableAgents数组(包含8个假Agent) - ✅ 页面现在仅显示从
/api/user/agents/platform获取的真实数据 - ✅ 无数据时显示空状态提示
4. data-tools/page.tsx
- ❌ 删除硬编码的 "3个已配置" 和 "5个已配置" Badge标签
🔧 角色权限映射
| 前端角色 | 后端role参数 | 登录入口 |
|---|---|---|
| 超级管理员 | super_admin |
/admin/login |
| 计费管理员 | billing_admin |
/admin/login |
| 运营管理员 | operations_admin |
/admin/login |
| 渠道管理员 | channel |
/channel/login |
| 租户用户 | user |
/login |
📌 注意事项
-
认证方式: 所有需认证接口支持
Authorization: Bearer <token>或X-API-Key: <api_key> -
角色映射: 前端系统权限与后端订阅级别映射
tenant→freeadmin→probilling-admin→enterpriseoperations-admin→enterprise
-
数据空值处理: 前端对返回数据做空值检查(如
capabilities || []) -
空状态显示: 当 API 无返回数据时,前端显示友好的空状态提示,不再使用假数据回退
📅 更新日志
- 2025-01: 清理前端所有假数据,确保页面仅使用 API 真实数据
- 2025-12-26: 初始版本,整理71个已完成接口