接口自动化测试（Python+Requests+Unittest）

Posted 2023-01-30 一个处女座的测试

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了接口自动化测试（Python+Requests+Unittest）相关的知识，希望对你有一定的参考价值。

(1)接口自动化测试的意义、前后端分离思想

接口自动化测试的优缺点：

优点：

测试复用性。

维护成本相对UI自动化低一些。

为什么UI自动化维护成本更高？
因为前端页面变化太快，而且UI自动化比较耗时（比如等待页面元素的加载、添加等待时间、定位元素、操作元素、模拟页面动作这些都需要时间）

为什么接口自动化维护成本较低？
因为接口较稳定，接口的响应时间基本上都是秒级、毫秒级别的，速度快，并且接口自动化本身也可以做一些有关联的操作、全流程的操作（比如：注册 --> 登录 --> 修改个人信息）。

回归方便。
可以运行更多更繁琐的测试。自动化的一个明显的好处是可以在较少的时间内运行更多的测试。
```
优点1、优点3、优点4是接口自动化和UI自动化公有的优点。
```

缺点：

不能完全取代手工测试。（自动化永远不能替代手工测试，只是提高测试效率）
手工测试比自动化测试发现的缺陷更多，自动化测试不容易发现新的BUG。

GET请求和POST请求的区别：

GET请求一般是从后台服务器上获取数据用于前端页面的展示（例如：看到列表页面等），POST请求是向服务器传送数据（登录、注册、上传文件、发布文章）。什么时候用GET，什么时候用POST取决于开发。无论用POST请求还是GET请求，都能完成对数据的增删改查，分不同的请求方式更多的是一种约定。
GET请求的请求参数是拼接在url后面的，只能以文本的形式传递参数，请求参数会显示在地址栏，数据长度受限于url的长度，传递的数据量小（4KB左右，不同浏览器会有差异），POST请求的请求参数是放在request body里面，传递数据量大（默认8M），对数据长度也没有要求。GET请求可以在浏览器中直接访问，而POST请求只能借助工具完成（比如：postman、jmeter）。
GET请求速度快，安全性不高；POST请求一般用于像登录这种安全性要求高的场合，请求不会被缓存，也不会保留在浏览器的历史记录中。

以前：get 查询；post 新增；put 编辑；delete 删除
现在：get 查询；post 新增 + 编辑 + 删除
或者：纯post走天下

前后端分离

开发模式

以前老的方式：

产品经理 / 领导 / 客户提出需求（提出文字需求）
UI做出设计图
前端工程师做html页面（用户能看到的页面）
后端工程师将html页面套成jsp页面（前后端强依赖，后端必须要等到前端的html页面做好才能套jsp。如果html发生变更，就很麻烦，开发效率低）
集成出现问题
前端返工
后端返工
二次集成
集成成功
交付

新的方式：

产品经理 / 领导 / 客户提出需求（提出文字需求）
UI做出设计图
前后端约定接口 & 数据 & 参数
前后端并行开发（无强依赖，可前后端并行开发，如果需求变更，只要接口 & 参数不变，就不用两边都修改代码，开发效率高）
前后端集成
前端页面调整
集成成功
交付

🤑通过F12打开浏览器开发者工具进行抓包，返回数据是json格式的就是前后端分离，返回时html页面就是没有前后端分离。

微服务的概念：

将大模块切分成小模块。减少代码的耦合度，从而降低模块与模块之间的影响。原先是一个jar包里面包含所有模块，改一个模块就有可能影响其他模块，现在是将一个一个的模块都打成一个一个的jar包，模块与模块之间的交互通过接口，哪个模块出了问题，只需要修改那个模块的jar包，避免因为修改一个模块的代码导致其他模块出错。

(2)Python requests框架讲解

接口自动化requests环境搭建

接口自动化核心库：requests

安装requests库的方法：

方法一：

命令行安装，打开cmd或者终端，输入以下命令：

pip install requests -i https://pypi.douban.com/simple/

方法二：
在pycharm中安装，settings --> Project --> Project Interpreter --> 点击“+”号 --> 输入request安装

测试环境是否ok

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/7 21:48

import requests

url_toutiao = "https://www.ixigua.com/tlb/comment/article/v5/tab_comments/?tab_index=0&count=10&group_id=6914830518563373581&item_id=6914830518563373581&aid=1768"
# 方式一：
# result_toutiao = requests.get(url_toutiao)

# 方式二：
result_toutiao = requests.get(url=url_toutiao)

# 方式三：
# result_toutiao = requests.get(
#     "https://www.ixigua.com/tlb/comment/article/v5/tab_comments/?tab_index=0&count=1&group_id=6914830518563373581&item_id=6914830518563373581&aid=1768")

# print(result_toutiao.json())
# print(type(result_toutiao.json()))  # <class 'dict'>
result = result_toutiao.json()
print(result)
expect_result = "华晨金杯汽车花朵朵"
actual_result = result["data"][0]["comment"]["user_name"]
print(actual_result)
if expect_result == actual_result:
    print("pass!")
else:
    print("failed!")

响应超时timeout

import requests

# V部落：http://[服务器ip]:8081/index.html
# 文章列表
url_v_article = "http://[服务器ip]:8081/article/all"
v_headers = 
    "Cookie": "studentUserName=ctt01; Hm_lvt_cd8218cd51f800ed2b73e5751cb3f4f9=1609742724,1609762306,1609841170,1609860946; adminUserName=admin; JSESSIONID=9D1FF19F333C5E25DBA60769E9F5248E"
article_params = "state": 1,  # -1：全部文章 1：已发表 0：回收站 2：草稿箱
                  "page": 1,  # 显示第1页
                  "count": 6,  # 每页显示6条
                  "keywords": ""  # 包含的关键字
                  
keywords = ["大橘猫", "跑男", "牙"]
for keyword in keywords:
    article_params["keywords"] = keyword
    # headers和params是不定长的，根据定义的字典传参
    # timeout超时，单位为秒
    # 通过设置超时时间，告诉requests在经过多久后停止等待响应
    result = requests.get(url_v_article, headers=v_headers, params=article_params, timeout=30)
    print(result.json())

JSON、URL、text、encoding、status_code、encoding、cookies

print(result.json()) # 响应结果以json的形式打印输出
print(result.url) # 打印url地址
print(result.text) # 以文本格式打印服务器响应的内容
print(result.status_code) # 响应状态码
print(result.encoding) # 编码格式
print(result.cookies) # cookie

JSON(JavaScript Object Notation, JS 对象简谱) 是一种轻量级的数据交换格式。它基于 ECMAScript (欧洲计算机协会制定的js规范)的一个子集，采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

JSON格式在Python里面相当于字典类型。

JSON格式化：JSON在线视图查看器(Online JSON Viewer)

url在线编码转换：URL在线编码转换工具 - 编码转换工具 - W3Cschool

(3)get、post、put、delete请求方式的自动化实现

GET请求方式

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/7 21:48

import requests

url_toutiao = "https://www.ixigua.com/tlb/comment/article/v5/tab_comments/?tab_index=0&count=10&group_id=6914830518563373581&item_id=6914830518563373581&aid=1768"
# 方式一：
# result_toutiao = requests.get(url_toutiao)

# 方式二：
result_toutiao = requests.get(url=url_toutiao)

# 方式三：
# result_toutiao = requests.get(
#     "https://www.ixigua.com/tlb/comment/article/v5/tab_comments/?tab_index=0&count=1&group_id=6914830518563373581&item_id=6914830518563373581&aid=1768")

# print(result_toutiao.json())
# print(type(result_toutiao.json()))  # <class 'dict'>
result = result_toutiao.json()
print(result)
expect_result = "华晨金杯汽车花朵朵"
actual_result = result["data"][0]["comment"]["user_name"]
print(actual_result)
if expect_result == actual_result:
    print("pass!")
else:
    print("failed!")
    
运行结果：
'message': 'success', 'err_no': 0, 'data': ['comment': 'id': 6914864825282215951, 'id_str': '6914864825282215951', 'text': '藁城出国打工的人很多，重点检查藁城区！', 'content_rich_span': '"links":[]', 'user_id': 940799526971408, 'user_name': '华晨金杯汽车花朵朵',, 'post_count': 0, 'stick_toast': 1, 'stable': True
华晨金杯汽车花朵朵
pass!

POST请求方式

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/9 22:51

import requests

url_v_login = "http://[服务器ip]:8081/login"
# 定义参数，字典格式
payload = 'username': 'sang', 'password': '123'
# Content-Type: application/json --> json
# Content-Type: application/x-www-form-urlencoded --> data
result = requests.post(url_v_login, data=payload)
# 将返回结果转为json格式
result_json = result.json()
print(result_json)  # 'status': 'success', 'msg': '登录成功'
# 获取RequestsCookieJar
result_cookie = result.cookies
print(result_cookie, type(result_cookie))  # RequestsCookieJar
# 将RequestsCookieJar转化为字典格式
result_cookie_dic = requests.utils.dict_from_cookiejar(result_cookie)
print(result_cookie_dic)  # 'JSESSIONID': 'D042C5FE4CFF337806D545B0001E7197'
# 获取SESSION
final_cookie = "JSESSIONID=" + result_cookie_dic["JSESSIONID"]  # SJSESSIONID=D042C5FE4CFF337806D545B0001E7197
print(final_cookie)

PUT请求方式

# V部落_编辑栏目

# 定义请求头，自动获取cookie的方法详情请看下文
headers = "Cookie": "VBlog(self.requests).get_cookie()"
new_now_time = time.strftime("%Y%m%d%H%M%S", time.localtime(time.time()))
new_category_name = "更新栏目" + new_now_time
payload = "id": 2010, "cateName": new_category_name
self.requests.put("http://[服务器ip]:8081/admin/category/", headers=headers, data=payload)

DELETE请求方式

# 删除栏目
result = self.requests.delete("http://[服务器ip]:8081/admin/category/" + “2010”, headers=headers)
print(result.json())  # 'status': 'success', 'msg': '删除成功!'
self.assertEqual("删除成功!", result.json()["msg"])

(4)接口自动化测试过程中cookie的处理

手动传入cookie的值（每次通过浏览器F12抓包，然后复制request header里面的cookie）

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/7 22:25

import requests

# V部落查询栏目
url_v_category = "http://[服务器ip]:8081/admin/category/all"
# 定制请求头
# 如果你想为请求添加HTTP头部，只要简单地传递一个字典给headers参数就可以了
v_headers = 
    "cookie": "studentUserName=ctt01; Hm_lvt_cd8218cd51f800ed2b73e5751cb3f4f9=1609742724,1609762306,1609841170,1609860946; adminUserName=admin; JSESSIONID=9D1FF19F333C5E25DBA60769E9F5248E"
result = requests.get(url_v_category, headers=v_headers)
# 打印json格式的响应结果
print(result.json())

cookie自动获取

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/9 22:51

import requests

url_v_login = "http://[服务器ip]:8081/login"
# 定义参数，字典格式
payload = 'username': 'sang', 'password': '123'
# Content-Type: application/json --> json
# Content-Type: application/x-www-form-urlencoded --> data
result = requests.post(url_v_login, data=payload)
# 将返回结果转为json格式
result_json = result.json()
print(result_json)  # 'status': 'success', 'msg': '登录成功'
# 获取RequestsCookieJar
result_cookie = result.cookies
print(result_cookie, type(result_cookie))  # RequestsCookieJar
# 将RequestsCookieJar转化为字典格式
result_cookie_dic = requests.utils.dict_from_cookiejar(result_cookie)
print(result_cookie_dic)  # 'JSESSIONID': 'D042C5FE4CFF337806D545B0001E7197'
# 获取SESSION
final_cookie = "JSESSIONID=" + result_cookie_dic["JSESSIONID"]  # SJSESSIONID=D042C5FE4CFF337806D545B0001E7197
print(final_cookie)

批量获取cookie脚本

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/9 23:26

import requests


def get_cookie(username, password):
    """通过考试系统学生登录获取单个cookie"""

    url_login = "http://[服务器ip]:8088/api/user/login"
    payload = "userName": username, "password": password, "remember": False
    result = requests.post(url_login, json=payload)
    # result_json = result.json()
    # print(result_json)

    # 获取RequestsCookieJar
    result_cookie = result.cookies
    # print(result_cookie, type(result_cookie))  # RequestsCookieJar
    # 将RequestsCookieJar转化为字典格式
    result_cookie_dic = requests.utils.dict_from_cookiejar(result_cookie)
    # print(result_cookie_dic)  # 'SESSION': 'YzFkM2IzN2QtZWY1OC00Nzc4LTgyOWYtNjg5OGRiZDZlM2E4'

    # 获取SESSION
    final_cookie = "SESSION=" + result_cookie_dic["SESSION"]  # SESSION=Mzc2...
    return final_cookie

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/9 23:23

from test01.demo04_student_login import get_cookie
import os


def get_batch_cookies():
    """批量获取cookie"""
    # 获取cookie之前，先将cookies.csv文件内容清空
    # with open(r"D:\\Desktop\\Testman_Study\\API_auto\\file\\cookies.csv", "w") as cookies_info:
    #     cookies_info.write("")
    # 或者将文件删除
    os.remove(r"D:\\Desktop\\Testman_Study\\API_auto\\file\\cookies.csv")

    # 读取csv文件
    with open(r"D:\\Desktop\\Testman_Study\\API_auto\\file\\register.csv", "r") as user_info:
        for user in user_info:
            user_list = user.strip().split(",")
            # 调用获取单个cookies的方法，传入注册好的用户名和密码
            cookies = get_cookie(user_list[0], user_list[1])
            # 将cookie追加写入文件
            with open(r"D:\\Desktop\\Testman_Study\\API_auto\\file\\cookies.csv", "a") as cookies_info:
                cookies_info.write(cookies + "\\n")


# 调用方法
get_batch_cookies()

register.csv(前提是这些账号和密码都是已经注册过的，可以直接登录)

poopoo001,123456,1
poopoo002,123457,2
poopoo003,123458,3
poopoo004,123459,4
......

cookies.csv

SESSION=ZmE3YmU4ZDctNDExZS00MDdhLWE0YjEtMjAyZjQxOTMxYmUx
SESSION=YjdkNTZhNTUtNGFmMi00MjVkLWEyNjctOTNiMmRmOTY1YTdm
SESSION=ZTJmMTYzMWEtZjUzOS00NTlhLWI0OWQtMzBmN2RkYmU4YmRi
SESSION=YTM0ZGRhOTctZjk5Ni00OWZhLTg1YTItZjUyMTMwZGE2MjVi
......

(5)不同类型请求参数的处理

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/7 22:25

import requests

# 文章列表
url_v_article = "http://[服务器ip]:8081/article/all"
v_headers = 
    "Cookie": "studentUserName=ctt01; Hm_lvt_cd8218cd51f800ed2b73e5751cb3f4f9=1609742724,1609762306,1609841170,1609860946; adminUserName=admin; JSESSIONID=9D1FF19F333C5E25DBA60769E9F5248E"

# 自定义url参数，定义一个字典，将参数拆分，再将字典传递给params变量即可
article_params = "state": 1,  # -1：全部文章 1：已发表 0：回收站 2：草稿箱
                  "page": 1,  # 显示第1页
                  "count": 6,  # 每页显示6条
                  "keywords": ""  # 包含的关键字
                  
keywords = ["大橘猫", "跑男", "牙"]
for keyword in keywords:
    article_params["keywords"] = keyword
    # headers和params是不定长的，根据定义的字典传参
    result = requests.get(url_v_article, headers=v_headers, params=article_params)
    print(result.json())

(6)结合Python+Requests+Unittest框架做接口自动化测试

unittest框架结构：

if _name_ == '__main__':

if __name__ == '__main__'的意思是：

当.py文件被直接运行时，if __name__ == '__main__'下的代码块将被运行；
当.py文件以模块形式被导入时，if __name__ == '__main__'下的代码块不被运行。

(7)接口自动化测试过程中高级断言

闭环断言（新增 --> 查询 --> 修改 --> 查询 --> 删除 -->查询）

    def test_article(self):
        # ①V部落_新增文章
        now_time = time.strftime("%Y%m%d%H%M%S", time.localtime(time.time()))
        title = "蔡坨坨" + now_time
        payload = "id": -1, "title": title, "mdContent": "文章内容", "state": 1, "htmlContent": "<p>文章内容</p>",
                   "dynamicTags": "", "cid": 62
        headers = "Cookie": VBlog(self.requests).get_cookie()
        result = self.requests.post("http://[服务器ip]:8081/article/", headers=headers, data=payload)
        # ②查询文章
        url_v_article = "http://[服务器ip]:8081/article/all"
        article_params = "state": 1,  # -1：全部文章 1：已发表 0：回收站 2：草稿箱
                          "page": 1,  # 显示第1页
                          "count": 6,  # 每页显示6条
                          "keywords": title  # 包含的关键字title
                          
        result = requests.get(url_v_article, headers=headers, params=article_params, timeout=30)
        print(result.json())  # 响应结果以json的形式打印输出
        ls = result.json()["articles"]
        act = 123
        # 查到新增的文章，说明新增成功
        for l in range(0, len(ls)):
            if ls[l]["title"] == title:
                act = "ok"
                article_id = ls[l]["id"]
        self.assertEqual("ok", act)
        # ③编辑文章
        now_time = time.strftime("%Y%m%d%H%M%S", time.localtime(time.time()))
        title = "修改文章" + now_time
        payload = "id": article_id, "title": title, "mdContent": "修改内容", "state": 1, "htmlContent": "<p>修改内容</p>",
                   "dynamicTags": "", "cid": 62
        headers = "Cookie": VBlog(self.requests).get_cookie()
        self.requests.post("http://[服务器ip]:8081/article/", headers=headers, data=payload)
        # 编辑完，查询文章
        url_v_article = "http://[服务器ip]:8081/article/all"
        article_params = "state": 1,  # -1：全部文章 1：已发表 0：回收站 2：草稿箱
                          "page": 1,  # 显示第1页
                          "count": 6,  # 每页显示6条
                          "keywords": title  # 包含的关键字title
                          
        result = requests.get(url_v_article, headers=headers, params=article_params, timeout=30)
        print(result.json())  # 响应结果以json的形式打印输出
        ls = result.json()["articles"]
        act = 123
        # 查到修改过的文章，说明编辑成功
        for l in range(0, len(ls)):
            if ls[l]["title"] == title:
                act = "ok"
                article_id = ls[l]["id"]
        self.assertEqual("ok", act)
        # ④查看文章详情
        article_id = str(article_id)
        result = self.requests.get("http://[服务器ip]:8081/article/" + article_id, headers=headers)
        print(result.json())
        if result.json()["title"] == title:
            act = "ok"
        self.assertEqual(act, "ok")
        # ⑤删除文章
        payload = 'aids': article_id, 'state': 1
        result = self.requests.put("http://[服务器ip]:8081/article/dustbin", headers=headers, data=payload)
        print(result.json())
        act = result.json()["msg"]
        self.assertEqual(act, "删除成功!")

(8)通过HTMLTestRunner.py生成可视化HTML测试报告

HTMLTestRunner.py百度网盘链接：

链接：百度网盘请输入提取码
提取码：p20c

# -*- coding:utf-8 -*-
# 作者：IT小学生蔡坨坨
# 时间：2021/1/10 13:45

from reports import HTMLTestRunner
from case.exam_case.teacher_case import TeacherCase
import unittest
import os
import time

# 创建测试套件
suite = unittest.TestSuite()

# 添加测试用例，根据添加顺序执行
# 添加单个测试用例
# suite.addTest(TeacherCase("test_001_admin_login"))

# 添加多个测试用例
suite.addTests([TeacherCase("test_001_admin_login"),
                TeacherCase("test_002_insert_paper"),
                TeacherCase("test_003_select_paper"),
                ])

# 定义测试报告的存放的路径
path = r"D:\\Desktop\\Testman_Study\\unittest_exam_system\\reports"
# 判断路径是否存在
if not os.path.exists(path):
    # 如果不存在，则创建一个
    os.makedirs(path)
else:
    pass
# 定义一个时间戳用于测试报告命名
now_time = time.strftime("%Y-%m-%d-%H-%M-%S", time.localtime(time.time()))
reports_path = path + "\\\\" + now_time + "(exam_report).html"
reports_title = u"考试系统&V部落——测试报告"
desc = u"考试系统&V部落——接口自动化测试报告"
# 二进制写
fp = open(reports_path, "wb")
runner = HTMLTestRunner.HTMLTestRunner(stream=fp, title=reports_title, description=desc)
# 运行
runner.run(suite)

postman、JMeter、requests总结：

postman：接口功能测试
JMeter：接口性能测试
requests：接口自动化
🐵三个的共同特点：都能完成接口功能测试。

以上是关于接口自动化测试（Python+Requests+Unittest）的主要内容，如果未能解决你的问题，请参考以下文章

python3+requestpython3+requests接口自动化测试框架实例详解教程

Python接口自动化--requests 1

Python——requests接口自动化测试

python自动化接口自动化：2.接口测试requests模块

python+requests接口自动化测试实战

Python+Requests实现接口自动化