1 需求整理

1.1 实现目的

• API 接口自动化测试，主要针对 http 接口协议；

• 便于回归测试；

• 线上或线下巡检测试，结合持续集成，及时发现运行环境存在的问题；

• 提升个人自动化测试技术能力，为业务提供强有力的测试手段。

1.2 功能需求

• 基于 Unittest，封装、调用和组织所有的测试用例，进行批量或指定用例运行；

• 支持邮件服务，可添加任意团队成员邮箱，及时通知团队成员自动化运行结果；

• 支持 log 日志，保存运行过程所有或需要记录的数据；

• 支持 HTML 测试报告，直观展示测试结果和数据；

• 支持用例设计和测试结果分离，便于数据管理；

• 支持 token/cookie 获取；

• 使用 HtmlTestRunner，可定制测试报告模板；

• 全局变量配置，一键修改使用公用参数；

• 支持单层接口依赖，可以扩展；

• 使用 excel 管理测试用例，接口数据写起来快速方便；

• 支持 Jenkins 持续集成；

• 提供测试对象（基于 Flask+Python 的学生管理系统）。

1.3 其他要求

• 模块化设计，项目框架形式组织代码；

• 公共方法封装，统一调用；

• 数据和结果分开，清晰明了；

• 支持邮件自定义；

• 代码注释清晰。

1.4 适用人员

• 有一定测试基础的软件测试人员；

• 有一定的代码（Python/Java）功底；

• 致力于学习 API 接口自动化测试的所有人员。

1.5 学习周期

• 两个星期到一个月，可达到独立进行 API 接口自动化测试；

1.6 学习建议

• 建议按照文章顺序，一步一步进行学习和实践；

• 文章是从基本的环境搭建到最终框架完全搭建的一个过程，相对来说还是比较详细的；

• 文章偏向于项目实战，未有太多的理论介绍和名词解释，所以对 0 基础的人员来说，可能需要额外的时间去补充一下知识；

• 文章重点是教如何搭建框架，因项目的差异化，可能要对框架中的部分代码进行修改。

2 详细设计

2.1 需求分析

对 实现需求 进行详细分析，主要有下：

2.2 技术栈

3 框架设计

3.1 框架说明

3.2 框架数据流

4 预期结果

4.1 测试过程 log 日志

4.2 测试报告 html 格式

4.3 测试报告邮件格式

4.4 Excel 用例格式