test-plan.md•6.43 kB
# Magic-API MCP 工具链真实API编写能力测试计划
## 📋 测试概述
本次测试专注于验证 Magic-API MCP 工具链的**真实API编写能力**,涵盖从API设计到部署的全流程能力验证。
### 🎯 测试目标
- **真实API创建能力**:验证创建各种类型API接口的功能
- **API调试与测试**:验证API调试、调用和错误处理能力
- **资源管理功能**:验证API分组、复制、移动等管理功能
- **搜索与查询**:验证API搜索、路径查询等发现功能
- **开发工作流**:验证完整的API开发工作流
### 🔒 安全原则
- **受控测试环境**:在专门的测试分组中进行所有操作
- **完整生命周期**:创建 → 测试 → 清理 的完整流程
- **渐进式验证**:每阶段完成后验证API功能正常
- **数据安全**:使用测试数据,确保不影响生产环境
### 📊 测试范围
专注于API编写能力的核心功能:
1. **API分组管理** - 创建、查询API分组
2. **API接口创建** - 各种HTTP方法和脚本类型的API
3. **API调试与测试** - 断点调试、API调用、性能测试
4. **资源管理** - API复制、移动、删除、锁定
5. **搜索与发现** - API搜索、路径查询、详细信息获取
6. **开发工作流** - 完整的API开发周期
## 🗂️ 测试环境
### 基本信息
- **系统版本**: 2.2.0
- **基础URL**: http://127.0.0.1:10712
- **WebSocket**: ws://127.0.0.1:10712/magic/web/console
- **认证**: 禁用
- **当前状态**: 空系统,无现有API资源
### 可用模块
- db, http, response, request, log, env, magic
- 自动导入: db, log
## 📋 详细测试计划
### 阶段1:开发环境准备
**目标**: 验证系统状态并准备测试环境
#### 1.1 系统状态验证
- [x] `get_assistant_metadata` - 获取系统基本信息 ✅
- [x] `list_available_modules` - 验证可用模块列表 ✅
- [x] `get_resource_tree` - 检查资源树结构 ✅
- [ ] `get_full_magic_script_syntax` - 获取语法规则
- [ ] `get_development_workflow` - 获取开发指南
#### 1.2 测试分组创建
- [ ] `save_group` - 保存分组,支持创建和更新测试专用分组
- [ ] `list_resource_groups` - 验证分组创建结果
### 阶段2:基础API创建能力测试
**目标**: 验证基本的API创建功能
#### 2.1 简单GET API创建
- [ ] 创建用户查询API (GET /test/users)
- [ ] 创建用户详情API (GET /test/users/{id})
- [ ] 验证API创建成功
#### 2.2 POST API创建测试
- [ ] 创建用户注册API (POST /test/users)
- [ ] 创建数据提交API (POST /test/data)
- [ ] 验证POST API功能
#### 2.3 其他HTTP方法测试
- [ ] PUT更新API (PUT /test/users/{id})
- [ ] DELETE删除API (DELETE /test/users/{id})
- [ ] PATCH部分更新API
### 阶段3:高级API编写功能测试
**目标**: 验证复杂的API编写场景
#### 3.1 数据库操作API
- [ ] 数据库查询API (SELECT操作)
- [ ] 数据库更新API (INSERT/UPDATE/DELETE)
- [ ] 事务处理API
- [ ] 分页查询API
#### 3.2 脚本语法功能测试
- [ ] 条件判断和循环
- [ ] 异常处理
- [ ] 函数定义和调用
- [ ] 异步处理
#### 3.3 模块使用测试
- [ ] HTTP客户端调用
- [ ] 响应处理和格式化
- [ ] 日志记录
- [ ] 环境变量使用
### 阶段4:API调试与测试功能
**目标**: 验证API调试和测试能力
#### 4.1 API调用测试
- [ ] `call_magic_api` - GET请求测试
- [ ] `call_magic_api` - POST请求测试
- [ ] `call_magic_api` - 复杂参数传递
- [ ] `call_magic_api` - 错误响应处理
#### 4.2 调试功能测试
- [ ] `get_debug_status` - 调试状态检查
- [ ] `get_websocket_status` - WebSocket连接
- [ ] `call_api_with_debug` - 带调试的API调用
- [ ] `execute_debug_session` - 调试会话管理
#### 4.3 断点调试测试
- [ ] 设置断点
- [ ] 单步执行
- [ ] 变量检查
- [ ] 调试状态管理
### 阶段5:资源管理功能测试
**目标**: 验证API资源管理能力
#### 5.1 API资源操作
- [ ] `copy_resource` - API复制功能
- [ ] `move_resource` - API移动功能
- [ ] `lock_resource` / `unlock_resource` - 资源锁定
- [ ] `delete_resource` - 资源删除
#### 5.2 资源查询与搜索
- [ ] `search_api_endpoints` - API搜索
- [ ] `get_api_details_by_path` - 路径查询
- [ ] `get_api_details_by_id` - ID查询
- [ ] `search_api_scripts` - 脚本内容搜索
#### 5.3 资源统计与分析
- [ ] `get_resource_statistics` - 资源统计
- [ ] `export_resource_tree` - 资源树导出
- [ ] `list_resource_groups` - 分组管理
### 阶段6:完整开发工作流测试
**目标**: 验证完整的API开发周期
#### 6.1 开发准备阶段
- [ ] 需求分析和设计
- [ ] 语法规则查阅
- [ ] 最佳实践参考
- [ ] 现有API分析
#### 6.2 开发实施阶段
- [ ] API分组规划
- [ ] 接口设计和创建
- [ ] 代码编写和调试
- [ ] 功能测试和验证
#### 6.3 部署与维护阶段
- [ ] API部署验证
- [ ] 性能测试
- [ ] 备份创建
- [ ] 文档更新
### 验证标准
- API创建成功率 100%
- API调用正常响应
- 调试功能完整可用
- 资源管理操作准确
- 搜索查询结果精确
- 错误处理清晰明确
## 📊 测试执行策略
### 分阶段执行
每个测试阶段完成后进行验证,确保:
- 阶段目标达成
- 无阻塞性错误
- 性能指标符合预期
### 验证方法
1. **自动化验证**: 编写测试脚本来验证响应格式和关键数据
2. **人工验证**: 关键结果的人工检查和确认
3. **性能监控**: 记录响应时间和资源使用情况
### 风险控制
- 所有测试均为只读操作
- 定期检查系统状态
- 准备应急回滚方案
- 监控系统资源使用
## 🎯 预期结果
### 成功标准
- 所有测试用例执行通过
- 响应准确率 100%
- 平均响应时间 < 2秒
- 无内存泄漏或资源异常
### 输出成果
1. 完整的测试报告
2. 性能基准数据
3. 最佳实践建议
4. 问题清单和改进建议
## 📝 测试记录
### 执行日志
- 测试开始时间: [待填写]
- 测试完成时间: [待填写]
- 测试执行者: Magic-API MCP Assistant
### 详细结果
- 成功用例数: [待填写]
- 失败用例数: [待填写]
- 跳过用例数: [待填写]
---
*本测试计划确保全面验证 Magic-API MCP 工具链的功能性和可靠性,同时严格遵守安全原则,避免对生产环境造成任何影响。*