hoteas
6b689f3a1b
- 在 .gitignore 中添加调试日志文件的忽略规则，避免不必要的调试信息被提交 - 修改 application.go 中的 stdout 重定向逻辑，使用 log.CaptureStream 以支持更灵活的日志捕获 - 更新 README 文档，增加对日志重定向功能的说明
70 lines
3.4 KiB
Markdown
70 lines
3.4 KiB
Markdown
---
|
||
name: 补充 Note 方法示例
|
||
overview: 在 Testing_API测试框架.md 的"第二步：编写测试用例"部分补充 Note 方法的使用示例和说明，同步更新 SKILL.md。
|
||
todos:
|
||
- id: doc-step2-example
|
||
content: 文档：在第二步的完整订单示例中加入 Note 调用示范
|
||
status: completed
|
||
- id: doc-note-section
|
||
content: 文档：在用例编写范式中新增 Note 使用说明（典型场景 + 示例 + 何时必须用）
|
||
status: completed
|
||
- id: doc-hotimev15-sync
|
||
content: 同步修改 hotimev1.5 中的 Testing_API测试框架.md
|
||
status: completed
|
||
- id: skill-note-guide
|
||
content: SKILL.md：补充 Note 使用指引和更多场景示例
|
||
status: completed
|
||
isProject: false
|
||
---
|
||
|
||
# 补充 Note 方法示例到文档和 Skill
|
||
|
||
## 现状分析
|
||
|
||
目前 `Note` 方法在文档中的存在情况：
|
||
|
||
- [链式 API 参考](d:\work\your-app\docs\Testing_API测试框架.md) 第 474、494 行：仅出现在 API 表格中，一句话描述
|
||
- [API 速查表](d:\work\your-app\docs\Testing_API测试框架.md) 第 662-668 行：只有一个简短示例（`sign = MD5(...)`)
|
||
- [SKILL.md](C:\Users\92597.cursor\skills\hotime-tdd-testing\SKILL.md) 第 195-197 行：一行示例
|
||
|
||
**缺失**："第二步：编写测试用例"（第 66-149 行）的完整订单示例中完全没有出现 `Note`，而这是新手学习的第一个入口。
|
||
|
||
## 需要修改的内容
|
||
|
||
### 1. 文档：第二步示例中加入 Note 使用
|
||
|
||
在 [Testing_API测试框架.md](d:\work\your-app\docs\Testing_API测试框架.md) 第 80-148 行的订单创建示例中，在**正确请求**部分加入 `Note` 调用，展示以下几种典型场景：
|
||
|
||
- 在正确请求处用 `Note` 说明参数值含义（如 `quantity=3` 是故意的用于校验总价 `29.9*3=89.7`）
|
||
|
||
### 2. 文档：用例编写范式中新增 Note 独立小节
|
||
|
||
在"用例编写范式"部分（第 219 行之后），在"错误用例"之前或之后，新增一个关于 Note 的说明段落或小节，覆盖以下典型使用场景：
|
||
|
||
- **参数值参考**：说明某个参数值的来源或含义，如 `Note("status: 0=待付款, 1=已付款, 2=已发货, 3=已完成")`
|
||
- **算法说明**：简要描述接口涉及的签名/加密算法，如 `Note("sign = MD5(smsProxyKey+timestamp)")`
|
||
- **接口/用例说明**：补充 desc 无法涵盖的上下文，如 `Note("需先调用 /api/cart/add 加入购物车")` 或 `Note("此接口支持批量操作，最多100条")`
|
||
- 在用例编写范式表格中增加 Note 的定位说明
|
||
|
||
### 3. 文档：同步更新 hotimev1.5 中的同名文件
|
||
|
||
[hotimev1.5/docs/Testing_API测试框架.md](d:\work\hotimev1.5\docs\Testing_API测试框架.md) 需要做相同的修改。
|
||
|
||
### 4. Skill 文件：补充 Note 指引
|
||
|
||
在 [SKILL.md](C:\Users\92597.cursor\skills\hotime-tdd-testing\SKILL.md) 中：
|
||
|
||
- 在 Phase 1 的 1.3 小节之后（或 1.2 和 1.3 之间），新增 Note 的使用指引
|
||
- 说明何时应该使用 Note（有必要的场景），给出 2-3 个典型示例
|
||
- 在 API 速查的"备注"部分补充更多场景示例
|
||
|
||
## 修改要点
|
||
|
||
- Note 不改变测试逻辑，只是给调试控制台和 api-spec.json 添加可读说明
|
||
- Note 是可选的，但在以下场景**建议必须**使用：
|
||
- 参数中有枚举值（如 status、type）需要说明各值含义
|
||
- 涉及签名/加密等算法的接口
|
||
- 接口有前置依赖或特殊调用顺序
|
||
- Note 可以放在链式调用的任意位置（`a.Note(...)` 或 `c.Note(...)`）
|
||
|