# ApiTest

**Repository Path**: coder_xup/api-test

## Basic Information

- **Project Name**: ApiTest
- **Description**: 2023年学习api自动化测试
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-06
- **Last Updated**: 2024-04-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 接口自动化

## README

# 项目简介

本项目实现接口自动化的技术选型：**Python+Requests+Pytest+YAML+Allure** 通过 Python+Requests 来发送和处理HTTP协议的请求接口，使用 Pytest 作为测试执行器，使用 YAML 来管理测试数据，使用 Allure 来生成测试报告。

## 项目说明

本项目在实现过程中，把整个项目拆分成请求方法封装、HTTP接口封装、关键字封装、测试用例等模块。

首先利用Python把HTTP接口封装成Python接口，接着把这些Python接口组装成一个个的关键字，再把关键字组装成测试用例，而测试数据则通过YAML文件进行统一管理，然后再通过Pytest测试执行器来运行这些脚本，并结合Allure输出测试报告。

还可以再对接口自动化进行Jenkins持续集成。

## 源码使用说明

首先，下载项目源码后，在根目录下找到 ```requirements.txt``` 文件，然后通过 pip 工具安装 requirements.txt 依赖，执行命令（确保当前是pip还是pip3）：

```
pip3 install -r requirements.txt
```

接着，修改 ```config/setting.ini``` 配置文件，主要配置接口域名和mysql数据库信息，pytest.ini为运行项目的相关参数。
```
testpaths-->为测试用例的文件夹
markers-->为打标签的测试用例
addopts-->为运行测试用例的参数（-q静默运行，--reruns 1失败重新运行，--alluredir ./report测试报告路径）
```

安装相应依赖之后，在命令行窗口执行命令：

```
pytest
```

**注意**：因为我这里是针对自己的接口项目进行测试，自己公司使用请重新编写测试用例

## 项目结构

- api ====>> 接口封装层，如封装HTTP接口为Python接口
- config ====>> 配置文件
- core ====>> requests请求方法封装、关键字返回结果类
- data ====>> 测试用例数据
- log  ====>> 日志
- message  ====>> 发送消息到钉钉/企业微信（需重新配置webhooks）
- report ====>> 测试报告文件夹
- test_requests/testcase ====>> 练习的用例
- testcases ====>> 项目的测试用例
- utils ====>> 工具类
- pytest.ini ====>> pytest配置文件
- requirements.txt ====>> 相关依赖包文件

## 项目效果

目前该框架在企业中完全是可以运用的，简单易上手。不过项目还没有做到只写测试用例，不写代码进行自动化测试。框架还是有进一步的优化空间，这个千人千面。如果想做的更完美，可以继续优化。

## 测试报告效果展示

在命令行执行命令：```pytest``` 运行用例后，会得到一个测试报告的原始文件，但这个时候还不能打开成HTML的报告，还需要在项目根目录下，执行命令启动 ```allure``` 服务：

```
# 需要提前配置allure环境，才可以直接使用命令行
allure serve ./report
```