# API-Test-Framework

**Repository Path**: Lmm_hub/API-Test-Framework

## Basic Information

- **Project Name**: API-Test-Framework
- **Description**: 基于Python + Pytest + Allure的API自动化测试框架，提供开箱即用的接口测试解决方案。
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-07-04
- **Last Updated**: 2025-08-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API自动化测试框架

## 项目简介
这是一个基于Python的API自动化测试框架，提供了一套完整的测试解决方案，包括HTTP请求封装、断言工具、YAML数据管理以及日志系统等功能。

## 项目架构
框架主要由以下几个核心模块组成：
- `common/api_request.py`: HTTP请求封装
- `common/assertion.py`: 断言工具
- `common/yamlUtils.py`: YAML数据管理
- `common/logging_use.py`: 日志系统

## 核心功能

### HTTP请求封装
提供了一个`ApiRequest`类，用于发送GET、POST、PUT和DELETE等HTTP请求。

### 断言工具
提供了一个`Assertion`类，包含多种静态方法用于进行断言操作。

### YAML数据管理
提供了一个`YamlUtils`类，用于读取和写入YAML文件中的数据。

### 日志系统
提供了一个`Logger`类，用于初始化日志配置并记录日志信息。

## 环境要求
- Python 3.x
- pytest
- requests
- PyYAML
- allure-pytest

## 安装和配置

### 安装依赖
```bash
pip install -r requirements.txt
```

### 安装Allure报告工具
请根据您的操作系统下载并安装Allure命令行工具。

#### Windows
```bash
scoop install allure
```

#### Mac
```bash
brew install allure
```

#### Linux
```bash
sudo apt-get install allure
```

### 配置项目
确保`config.py`文件中已正确配置基础URL和其他必要的设置。

## 使用方法

### 运行测试
#### 运行所有测试
```bash
pytest
```

#### 运行特定测试文件
```bash
pytest test_api/test_login.py
```

#### 运行特定测试方法
```bash
pytest test_api/test_login.py::TestLogin::test_login
```

### 查看测试报告
#### 生成Allure报告
```bash
allure generate report -o report/html
```

#### 启动报告服务器
```bash
allure serve report
```

### 添加新的测试用例
#### 步骤1：创建测试数据
在`data`目录下创建或更新YAML文件以存储测试数据。

#### 步骤2：创建测试用例
在`test_api`目录下创建新的测试类和方法，并利用`YamlUtils`读取测试数据。

## 配置说明

### 配置文件
`config.py`文件包含了项目的全局配置，如基础URL、超时时间等。

### 数据文件
测试数据存储在`data`目录下的YAML文件中。

### 日志配置
日志配置通过`common/logging_use.py`中的`Logger`类进行初始化。