Files
hotime/.cursor/plans/精简测试框架文档_af7f35a5.plan.md
T
hoteas df6bf94b0b feat(api): 增强 API 测试框架功能与文档
- 在 Api 结构中新增 lastResp 字段以存储最近请求的响应
- 添加 Verify 方法,支持自定义校验函数并返回 ApiCase 构建器
- 新增 Resp 方法,获取最近一次请求的响应以便于断言
- 在 TestCollector 中添加 Visited 字段,记录已调用的路径
- 更新 GenerateSwagger 方法,支持部分运行时保留未运行端点的已有数据
- 完善文档,增加用例编写范式和示例,提升测试框架的可用性与易用性
2026-03-30 01:55:07 +08:00

3.9 KiB
Raw Blame History

name, overview, todos, isProject
name overview todos isProject
精简测试框架文档 将 Testing_API测试框架.md 从 1210 行精简到约 750-800 行,删除与"编写测试用例"无关的冗余内容,同时保留/强化全过程验证示例,防止 AI 写出只验证接口通不通的浅层测试。
id content status
simplify-biz-code 「快速开始 → 第一步:业务代码」改成极简示例(3-5行的伪代码),不再展开完整 OrderCtr,节约约40行 completed
id content status
delete-framework-changes 删除「框架改动说明」整节(约25行) completed
id content status
delete-login-compare 删除「不好的写法 vs 推荐的写法」中的登录完整对比示例(约45行),前面各小节已有对比,不需要再重复一遍 completed
id content status
trim-swagger-console 缩减「API 调试控制台」,只保留 GenerateSwagger 调用方式和输出目录结构,删除14行功能特性表和侧边栏示意图(约-30行) completed
id content status
trim-api-spec-fields 删除「api-spec.json 覆盖率字段说明」中的字段详解大表和徽章规则(约-30行),只保留 JSON 结构示例 completed
id content status
trim-concurrency 精简「并发保护与缓存隔离」,删除逐操作加锁保护表,只保留结论性描述(约-20行) completed
id content status
trim-apiresponse 删除 ApiResponse GetBody vs Obj 的解释性注释块(约-10行) completed
id content status
trim-run-range 删除「指定运行范围」末尾重复的子测试层级树(约-10行) completed
id content status
trim-binary 精简「二进制与非JSON响应校验」,删除图片下载示例(与xlsx示例高度重复,约-30行) completed
false

精简测试框架文档

目标:docs/Testing_API测试框架.md 从 1210 行 → 约 750-800 行

核心原则调整(与初稿的区别)

  • 快速开始必须完整:第一步「业务代码」不删除,改为极简示意(3-5行伪代码),让读者明白"这里有个接口"即可,不展开完整逻辑
  • 全过程验证示例必须保留并强调Verify + DB 校验 + 响应值断言的示例是文档核心,AI 容易偷懒只写 Post("xxx", 0) 不做任何校验,这种浅层用例要明确标为"不好的写法"
  • 其余按实用性裁剪

删除/精简内容(约 -400 行)

  • 精简「第一步:业务代码」-40 行):OrderCtr 有50行,改成极简伪代码 + 注释说明接口做什么,让后续测试示例有上下文即可
  • 删除「框架改动说明」整节(-25 行):内部实现历史,对写测试无任何指导价值
  • 删除「不好的写法 → 登录完整对比」(-45 行):前面3个对比子节已充分说明问题,第4个只是换了场景重复
  • 缩减「API 调试控制台」-30 行):只保留 GenerateSwagger 调用 + 输出目录结构,删除14行功能表和侧边栏结构图
  • 删除「api-spec.json 字段详解表」-30 行):与写测试无关
  • 精简「并发保护与缓存隔离」(-20 行):删除逐操作加锁表,保留结论
  • 删除 ApiResponse GetBody vs Obj 解释块-10 行)
  • 删除「指定运行范围」末尾层级树(-10 行):bash 示例中注释已足够
  • 精简「二进制响应校验」-30 行):只保留 xlsx + CSV,删除重复的图片示例

保留/强化内容

  • 概述能力表格
  • 快速开始(完整4步,业务代码改极简)
  • 用例编写范式(全部4节 + 不好vs推荐对比的前3节) ← 核心,不裁
  • 核心类型
  • 链式 API 参考(三张表)
  • API 速查表
  • 事务隔离机制
  • 覆盖率报告(保留 PrintCoverage 输出示例)
  • 指定运行范围(bash 示例)
  • 并发保护与缓存隔离(精简版)
  • 二进制响应校验(精简版)