关于 api-test-bruno
为使用 Bruno 的团队提供 API 测试规划与产出指导,强调依据已知信息生成可执行的 smoke 断言,并明确标注假设和缺口。
主要功能
- 01生成 Bruno 结构的 API 测试结果
- 02要求端点与预期状态码明确
- 03缺少必要数据时生成失败工件
- 04按风险优先安排测试场景
- 05使用占位符或环境变量处理凭据
适用场景
- 01为现有 Bruno 项目规划 API 测试
- 02根据已确认端点生成 smoke 测试
- 03识别测试需求中的假设与信息缺口
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ naodeng/ awesome-qa-skills --skill api-test-bruno安装后在 Claude Code 中输入/api-test-bruno确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
README.mdagents/openai.yamlevals/eval.yamltrigger_queries.jsonevals/cases/basic-success.yamledge-bad-or-neighbor.yamledge-incomplete-input.yamlreview-repair-regression.yamlevals/fixtures/openapi-orders.yamlsample-curls.shevals/fixtures/scripts/check_bruno_output.shevals/graders/review-repair-regression.pyexamples/sample.curlsample.insomnia.jsonsample.openapi.yamlsample.opencollection.jsonsample.postman_collection.jsonsample.wsdlexamples/bruno/sample.bruexamples/ci/github-actions-bruno.ymlJenkinsfile.brunooutput-templates/template-markdown.mdprompts/api-test-bruno.mdreferences/framework-spec.mdgenerator-contract.mdreport-schema.mdsetup-and-ci.mdreferences/local/api-testing.mdscripts/api_case_contract.pycheck_bruno_report.py详细介绍
原文在翻译后有更新,译文可能不是最新。
api-test-bruno (EN)
中文版: 请参阅对应的中文技能。
使用场景
- 需要生成适合放入 Bruno 结构或 Bruno 工作流的 API 输出。
- 项目已在使用 Bruno,或希望采用适配 Bruno 的组织方式。
生成与执行边界
生成器仅针对已知字段生成冒烟断言:要求端点非空,并明确指定 expected_statuses;expected_json 和有来源依据的 max_response_ms 为可选项。数据缺失、参数或变量未解析,或包含架构断言时,会生成不完整的脚手架并以非零状态码退出。请阅读 references/generator-contract.md;明确配置目标和凭据。
工作流
- 阅读并遵循渐进式披露中列出的主提示词(覆盖范围、结构、质量标准)。
- 仅补充会影响结果的项目背景:范围、环境、约束、风险、依赖项、预期交付物。
- 如果输入不完整,请提供可用的初稿,并明确标注假设和缺漏。
- 默认使用 Markdown;仅在用户提出要求时切换格式。
核心约束
- 按风险/业务影响确定优先级,不要一视同仁。
- 将已确认事实与当前假设分开。
- 不要编造用户未提供的端点、字段、环境或根本原因。
- 使用占位符或环境变量语义处理身份验证信息/密钥;切勿硬编码真实凭据。
- 保持输出可执行:场景具体、优先级明确、后续步骤清晰。
渐进式披露
- 生成输出前,阅读并遵循
prompts/api-test-bruno.md(最低覆盖要求、输出结构、质量标准)。 - 适用现成模板时:使用
output-templates/下匹配的文件。 - 用户需要示例或希望与现有资源保持一致时:阅读相关的
examples/。 - 需要深入了解框架、故障排查或架构说明时:仅阅读
references/下相关文件,不要加载整个目录。 - 进行格式转换或辅助检查时:优先使用现有
scripts/,不要重复造轮子。 - 评估或回归测试此技能时:使用
evals/和 skill-up。
交付前检查清单
- 遵循了主提示词的输出结构
- 重点关注最低覆盖要求:集合结构、环境设置、身份验证处理、优先级端点、正向场景、负向和边界场景、数据或变量策略、断言重点等(详情见主提示词)
- 覆盖了最低检查清单,或说明了未覆盖项
- 高风险项已明确标注优先级
- 未编造用户未提供的细节
- 已标注假设和缺漏
常见陷阱
- 范围/背景信息缺失时,不要假装内容完整。
- 不要将所有事项都视为同等重要。
- 不要遗漏假设和信息缺口。
- 不要罗列与当前工具链无关的通用理论。
评论
支持 Markdown