SuperAPI AI 工具集

apidog-test-automation

测试与质量

查看项目

更新于 10-15 16:51

技能介绍

用途:本技能聚焦 Apidog CLI 的测试自动化,包括测试套件(test-suite)、定时任务(scheduled-task)、runner、apidog run 执行参数、迭代数据、报告上传与 CI 回归。使用前需先阅读 ../apidog-cli/SKILL.md;如与稳定入口技能冲突,以当前 CLI help 和本技能为准。复杂场景步骤建模参阅 ../apidog-test-scenario/SKILL.md,单接口用例参阅 ../apidog-test-case/SKILL.md。

资源边界:单接口用例用 test-case;多步骤业务流程用 test-scenario;多场景回归集合用 test-suite;定时执行用 scheduled-task;私有执行机用 runner;查看结果用 test-report(按当前 CLI help 查询或下载)。

创建与更新:test-suite create --name 只生成空套件,items: [] 表示不是可用回归套件;除用户明确需要占位套件外,应通过 --file 或后续 update 添加条目并用 get 确认非空。非空套件应采用 cli-schema get test-suite-create 给出的前端兼容结构(如 STATIC_TEST_CASE 与 testCases[].id 引用),不要用 { testScenarioId } 等旧式写法。runner 是团队级资源,创建前确认团队与用途,常见组合为 runnerType=GENERAL、serverType=SELF_HOSTED。不要用空示例创建定时任务;runOn 只使用当前 CLI help/schema 支持的值(如 APP/TSHGR/OSHGR),不要用 CLOUD 等不支持值。更新前先获取原始结构。

运行:用 apidog run --help 及各命令帮助确认参数。CI 中应明确环境、reporters、out-dir、upload-report、iteration、变量覆盖、timeout、bigint 行为及是否需要 --carry-runtime-variables。最小 CI 命令示例:apidog test-suite run <suiteId> --project <projectId> --environment <environmentId> --reporters cli,json,junit --upload-report。

执行后:本地报告看 --out-dir 与 --out-file;云报告仅在带 --upload-report 运行时产生,再用 test-report list/get/download。失败诊断按 CLI 输出、JSON 报告、agentHints 顺序定位到具体场景、套件或用例。未加 --upload-report 时云报告列表不包含本次运行。CI 中显式指定 --environment,令牌通过 CI secrets 注入,切勿提交。

常见问题恢复:场景步骤不对切到 apidog-test-scenario 并确认创建后是否更新;套件运行为空用 test-suite get 确认;items: [] 是空占位;CI 找不到环境用 environment list/get 确认 environmentId;runner 不可用先 runner check 再查 runner get/list;报告缺步骤详情需区分本地 JSON、云上传与下载摘要,必要时切到 apidog-cli-checkup。

限制:具体参数以当前 CLI help 为准;本技能不涉及未提供或编造的收费、价格、平台与效果信息。