41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
|
---
|
|||
|
|
name: 测试框架文档编写
|
|||
|
|
overview: 在 docs/ 目录新增 API 测试框架文档，并在 README.md 文档表格中增加入口链接，保持与现有文档风格一致。
|
|||
|
|
todos:
|
|||
|
|
- id: docs-testing
|
|||
|
|
content: 新增 docs/Testing_API测试框架.md 文档
|
|||
|
|
status: completed
|
|||
|
|
- id: readme-entry
|
|||
|
|
content: README.md 文档表格增加测试框架入口
|
|||
|
|
status: completed
|
|||
|
|
isProject: false
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# API 测试框架文档
|
|||
|
|
|
|||
|
|
## 改动文件
|
|||
|
|
|
|||
|
|
### 1. 新增 `docs/Testing_API测试框架.md`
|
|||
|
|
|
|||
|
|
参照现有文档风格（如 QUICKSTART.md、HoTimeDB_API参考.md），包含以下章节：
|
|||
|
|
|
|||
|
|
- 概述（事务回滚隔离 + 链式 API + 覆盖率 + Swagger）
|
|||
|
|
- 快速开始（3 步接入示例）
|
|||
|
|
- 核心类型（TestProj/TestProjDef/ProjTest/CtrTest/ApiTestDef）
|
|||
|
|
- 链式 API 参考（Api/ApiCase/ApiResponse 的所有方法）
|
|||
|
|
- 完整场景对照表（GET/POST/JSON/Form/File/混合/WithSession）
|
|||
|
|
- 事务回滚机制说明（testTx + SAVEPOINT 原理）
|
|||
|
|
- 覆盖率报告（PrintCoverage 输出示例）
|
|||
|
|
- Swagger 文档生成（GenerateSwagger 用法）
|
|||
|
|
- 指定运行范围（go test -run 用法）
|
|||
|
|
- 框架改动说明（db 层 3 文件改动概述）
|
|||
|
|
|
|||
|
|
### 2. 修改 [README.md](d:/work/hotimev1.5/README.md)
|
|||
|
|
|
|||
|
|
在文档表格（第 18-27 行）中增加一行：
|
|||
|
|
|
|||
|
|
```markdown
|
|||
|
|
| [API 测试框架](docs/Testing_API测试框架.md) | 接口测试、事务隔离、覆盖率追踪、Swagger 文档生成 |
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
插入位置：在"改进规划"行之前，作为文档表格的倒数第二行。
|