SuperAPI AI 工具集

apidog-cli

测试与质量

查看项目

更新于 10-15 16:51

技能介绍

用途:通过 Apidog CLI 完成 Apidog 项目资源管理,包括运行 API 自动化测试/测试套件,以及查询、创建、更新、删除资源。不要凭记忆猜测请求内容,应以 CLI 输出为准驱动下一步操作。

入门检查:首次处理任务时验证 CLI 可用性:apidog --version、apidog --help。若缺失或无法输出版本,先安装:npm install -g apidog-cli@latest。安装后运行 apidog login --with-token <TOKEN>。令牌可在 Apidog 应用或网页控制台获取:用户头像 → Account Settings → API Access Token。默认不必每次升级,仅在版本过低、未知命令或参数问题等场景再建议升级。

基础用法:apidog --help;apidog <command> --help;apidog <command> <subcommand> --help。常用全局选项包括 --project、--branch、--access-token、--api-base-url(私有部署地址)。

登录与项目:未登录时向用户索要 API 访问令牌再登录。令牌存于 ~/.apidog/config.toml,禁止在日志、仓库或聊天摘要中输出。用户未指定项目时,先检查工作区 .apidog/settings.json 中的默认 projectId。项目 ID 可从 Project Settings - Basic Settings - Project ID 获取,或先运行 apidog project list 让用户确认。写入本地配置文件前须询问用户。

写入流程:create 或 update 前先获取资源定义与数据格式,再校验。获取 schema:apidog cli-schema get <schemaKey>;生成 JSON 数据文件;校验:apidog cli-schema validate <schemaKey> --file <path>;校验通过后才执行真实写入。之后优先读取 JSON 输出中的 agentHints.nextSteps 继续或恢复。具体命令、选项和 schema 键须以当前 CLI 输出为准。

权限与 AI 分支:写入被 AI 权限阻止时,不要替用户决定,应询问是否在目标分支启用直接编辑权限,或通过 AI 分支编辑。直接编辑主分支、冲刺分支或通用分支,需在 Apidog 客户端 2.8.32+ 的 Project Settings - Feature Settings - AI Feature Settings - External AI Edit Permissions 中开启权限。选择 AI 分支的流程为:创建 AI 分支并指定源分支;按需导入(pick-to)源分支资源;按请求编辑;完成后请用户确认是否创建合并请求或合并。直接运行 merge 或 merge-request 需要源分支与目标分支均启用直接编辑权限开关。AI 分支是隔离分支,24 小时内与源分支无差异会被自动归档;初始为空且不自动克隆资源;新建资源无需先导入;变更不会自动写回。目标主分支受保护时优先使用 merge-request。

须询问用户:登录令牌、本地配置写入、私有部署 URL;创建/切换 AI 分支、导入源资源;删除、归档、覆盖导入、批量更新等破坏性操作;通过 merge / merge-request 合并;是否升级 CLI。

恢复指引:未登录用 apidog login --with-token <TOKEN>;未知项目用 apidog project list;未知参数用 apidog <command> --help;参数或 schema 错误先运行 cli-schema get / cli-schema validate;AI 写入被阻止时说明 AI 分支/权限开关并让用户选择;私有部署加 --api-base-url https://your-server。