SuperAPI AI 工具集

open-collection

测试与质量

查看项目

更新于 10-16 09:44

技能介绍

用途:读取 docs/api/*.yaml 的自定义 YAML API 规范,生成可运行的 Bruno OpenCollection;该 api-spec 由 neo 编写,并已由 openapi-doc 与 Go 代码做过漂移校验,本技能只读不写。

来源模式(必须询问用户,不自动推断):Spec 模式为每个 endpoint 生成一个可运行、自文档化的请求,按 domain 分组,并生成 environments/ 与 folder.yml;AC-scenario 模式为每个 Ready AC 生成一个带 runtime.assertions 的请求,需要同时具备 api-spec 与 docs/design/<usecase>/acceptance-criteria.html(test-cases.html 为可选增强),缺失则停止并指向 neo。

主要能力与结构:opencollection.yml(集合根配置,Spec 模式下 docs 来自 _meta 索引)、environments/(每环境一文件,含 baseUrl 与请求中引用的 {{name}} 变量,疑似密钥写为空值并加 secret: true)、<group>/folder.yml、<group>/<endpoint>.yml(顺序为 info → http → docs → settings),http.body.data 原样复制 request_body.example。

必要用法:模式自动检测(无 opencollection.yml 为 Generate,要求校验为 Validate,否则 Update)。写完后运行校验:Spec 模式 python3 <ASSET_DIR>/colcheck.py <collection-root> --spec docs/api;AC-scenario 模式加 --design docs/design/<usecase>。需 PyYAML。脚本为机械检查,之后可选用独立 fresh-eyes 验证与完整性扫描。

限制:不是源生成器,不是 Confluence 发布器,不是手写/curl/Postman/OpenAPI 转换器或交互式编辑器,也不是测试用例生成器;AC-scenario 只把已有 Ready AC 转为可运行请求,不写入设计文档。密钥不写实际值,multipart/oauth 等需人工复核。价格、收费等未提供。