# req_unit

**Repository Path**: kuiket/req_unit

## Basic Information

- **Project Name**: req_unit
- **Description**: 接口单字段测试验证框架，主要包含6种验证场景：1）删除字段验证；2）字段值为空验证；3）字段值含特殊字符验证；4）空报文验证；5）不存在字段验证；6）单独传一个字段验证。框架使用Python的requests库发送HTTP请求，通过pandas记录测试结果并输出到Excel文件。该框架可快速验证接口的健壮性，但代码存在可优化空间，如冗余代码精简、异常处理完善等。
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-14
- **Last Updated**: 2025-08-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# req_unit 接口单元测试工具

## 项目简介
`req_unit` 是一个用于接口单元测试的工具，可以验证接口在各种异常场景下的表现。该工具会自动测试多种异常情况，包括字段缺失、字段错误、字段值为空、字段值错误以及请求报文为空等场景，并将测试结果保存到 Excel 文件中。

## 主要功能
- **字段缺失测试**：验证删除请求中的字段时接口的响应。
- **字段错误测试**：验证字段名错误时接口的响应。
- **字段值为空测试**：验证字段值为空时接口的响应。
- **字段值错误测试**：验证字段值错误（如包含特殊字符）时接口的响应。
- **请求报文为空测试**：验证请求报文为空时接口的响应。
- **单独字段测试**：验证仅传递单个字段时接口的响应。

## 使用方法

### 安装依赖
确保安装了以下依赖库：
- `requests`
- `pandas`
- `openpyxl`

可以通过以下命令安装：
```bash
pip install requests pandas openpyxl
```

### 示例代码
```python
from req_report.data import OpneData as od
from req_unit import req_verify

# 调用测试函数
req_verify(
    url=od.host + od.get_group_url,
    method='post',
    json_body=od.get_group,
    header=od.header,
    remark=od.get_group_r
)
```

### 参数说明
- `url`: 接口地址。
- `method`: 请求方法（如 `get`, `post`）。
- `header`: 请求头信息。
- `remark`: 测试备注信息。
- `body`: 请求体（表单格式）。
- `json_body`: 请求体（JSON 格式）。

## 测试报告
测试结果会保存在 `report` 目录下的 Excel 文件中，文件名基于接口 URL 的最后一部分生成。

## 文件结构
- `req_unit.py`: 主要测试逻辑。
- `data.py`: 存储测试所需的配置数据。
- `report/`: 存放测试结果的 Excel 文件。

## 许可证
该项目使用 MIT 许可证。有关详细信息，请参阅 [LICENSE](LICENSE) 文件。

## 贡献指南
欢迎贡献代码！请遵循以下步骤：
1. Fork 项目。
2. 创建新分支。
3. 提交更改。
4. 创建 Pull Request。

## 问题反馈
如有任何问题，请在 Gitee 上提交 Issue。

## 联系方式
- 作者：[kuiket](https://gitee.com/kuiket)
- 项目地址：[https://gitee.com/kuiket/req_unit](https://gitee.com/kuiket/req_unit)

---

该项目旨在帮助开发者快速验证接口在各种异常情况下的行为，确保接口的健壮性和可靠性。