SuperAPI AI 工具集

apidog-import-export

编程与开发

查看项目

更新于 10-15 16:51

技能介绍

用途:在 Apidog 中完成 API 规范的导入、导出与质量校验,覆盖 OpenAPI、Postman、Swagger、HAR 及 Apidog 原生格式。使用前需先阅读 ../apidog-cli/SKILL.md。

主要能力:从代码、PRD、需求或测试文档生成 API 规范并导入;导入已有文件;配置自动导入;导出 OpenAPI、Markdown、HTML、Postman 或原生格式;判断生成的规范是否仅为路由骨架;迁移、备份或复制 Apidog 项目并控制模块策略。

使用方式:始终以当前 CLI help 获取准确参数。命令形态示例: apidog import --project <projectId> --format openapi --file <openapiFile> apidog import --project <projectId> --format postman --file <postmanFile> apidog import --project <projectId> --format apidog --file <nativeFile> --module-import-mode match-name apidog export --project <projectId> --format openapi --output <file> apidog export --project <projectId> --format markdown --output <file> apidog export --project <projectId> --format apidog --output <file> 原生格式导入的模块策略可选 match-name、new 或 --module-map。

质量门禁:导入前先解析文件,报告真实 paths、operations、schemas、writes、withBody、emptyObjectBodies 等指标。注意写入类 API 缺少 requestBody、请求体为空对象、方法加路径但无 schema、tags 缺失等风险信号;大量 ignoreCount 属风险信号。

导入后校验:确认成功与退出码,检查导入数、忽略数与警告,用 list/get 等确认资源可见性与模块归属;不得仅凭命令返回成功即视为完成。

限制:导入或复制现有端点、测试用例、场景步骤到测试场景应改用 apidog-test-scenario;精确维护场景步骤、变量、断言或处理器也使用该技能。不要凭扩展名判断格式,生成器可能将 YAML 写入 .json 文件。项目未指定目标项目、团队或导入策略时应先确认。导出后需确认文件存在且格式有效。其余未提供。