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