SuperAPI AI 工具集

apidog-test-case

编程与开发

查看项目

更新于 10-15 16:51

技能介绍

用途:在 Apidog CLI 中管理绑定单个接口的 API 测试用例,覆盖查询、创建、更新、删除、分类和运行测试用例,以及创建和维护测试数据集。使用前提是先阅读 ../apidog-cli/SKILL.md;若稳定入口技能与本领域技能冲突,以当前 CLI 帮助和本技能为准。多步骤流程应改读 ../apidog-test-scenario/SKILL.md。

主要能力:test-case 管理用例、步骤、断言、变量提取器和前置/后置处理器;test-case category 获取有效 categoryId;test-data 维护迭代运行的数据源;apidog run --test-case 按 caseId 运行用例;test-case list --endpoint <endpointId> 查看某接口下的用例。适用于创建单接口自动化用例、更新测试步骤与断言、诊断客户端不显示步骤、断言无效或提取变量为空等问题。

使用方式:确认项目和分支;用 apidog endpoint list/get 定位接口;运行 apidog test-case category --project <projectId> 获取有效 categoryId;存在相似用例时先 list 再 get 作为模板;获取并校验 test-case-create schema;构建完整 JSON 负载,不要只写 name/endpointId 的空壳;创建后立即 test-case get <caseId> 确认后端保存结构;需要时本地运行并生成 JSON 报告。更新前必须先 get 原始完整结构再修改,update 不是 JSON Patch,不会按 id 合并数组元素;payload 写入前必须 cli-schema validate,写入后必须 get 复核。

结构要点:requestBody.data 必须是字符串,不能把 JSON Body 写成对象;多行 JSON、前置和后置脚本用 \n 格式化;preProcessors 和 postProcessors 使用扁平结构 { id, type, data, defaultEnable, enable },不要用旧式嵌套 { type, config };处理器建议使用稳定 id;提取全局变量时用 data.variableType: "globals",需要作用域时优先 data.shareScope: "PROJECT",TEAM 为团队级且可能依赖付费能力,除非明确要求不要默认使用。

限制与注意:categoryId 是客户端显示的关键必填字段,无效值可能导致用例在 CLI 可见但客户端不可见或不可用;导入到测试场景时不要在本技能手写场景步骤,应切换到 apidog-test-scenario 并使用 import-steps;test-case get 的 method 可能返回空字符串,这通常由绑定接口决定显示,不要擅自改写;客户端显示成功不等于执行成功,必要时同时验证保存结构与运行结果;新参数缺失时使用 apidog-cli-checkup 核对版本和帮助。具体参数以当前 CLI 帮助为准。

适用场景:单接口测试用例的创建与维护、断言和变量提取问题排查、测试数据集管理。不适合多接口编排、仅运行已有场景或套件、仅编辑接口定义、仅查看报告等场景。