当前位置: 首页 > news >正文

API Object设计模式

API测试面临的问题

API测试由于编写简单,以及较高的稳定性,许多公司都以不同工具和框架维护API自动化测试。我们基于seldom框架也积累了几千条自动化用例。

•简单的用例

import seldomclass TestRequest(seldom.TestCase):def test_post_method(self):self.post('/post', data={'key':'value'})self.assertStatusCode(200)def test_get_method(self):payload = {'key1': 'value1', 'key2': 'value2'}self.get("/get", params=payload)self.assertStatusCode(200)if __name__ == '__main__':seldom.main(base_url="http://httpbin.org")

•场景测试用例

在复杂场景中,比如,多个接口会用到的一些公共接口。

首先,封装一个公共类。

# common.py
from seldom.request import check_response 
from seldom.request import HttpRequestclass Common(HttpRequest):@check_response(describe="获取登录用户名",status_code=200,ret="headers.Account",check={"headers.Host": "httpbin.org"},debug=True)def get_login_user(self):"""调用接口获得用户名"""headers = {"Account": "bugmaster"}r = self.get("http://httpbin.org/get", headers=headers)return r

然后,调用common编写用例。

import seldom
from common import Commonclass TestRequest(seldom.TestCase):def start(self):self.c = Common()def test_case(self):# 调用 get_login_user() 获取user = self.c.get_login_user()self.post("http://httpbin.org/post", data={'username': user})self.assertStatusCode(200)if __name__ == '__main__':seldom.main(debug=True)

•其他用例

还有一些用例是通过数据驱动文件(CSV\EXcel…等)维护的,这里就不举例了。

以上写法基本没有问题。但是,随着参与编写自动化的人变多,自动化用例不断增加。一些问题就暴露出来了。

比如,A测试需要多条用例需要用到登录token,于是,将一个登录API封装成一个user_login()使用。B测试遇到这个场景大概率也会这么干!同样封装一个user_login()使用。庞大的自动化项目中会存在大量类似的冗余代码。当登录的API发生变化的时候,所有涉及到的用例或封装都需要修改。这个维护成本是很高的。

实际上,我们的项目就正在面临这个严重的问题。整个API自动化项目分多个团队,几十个人参与编写API测试用例&提交代码。没有引入清晰的分层设计,形成这些问题几乎是必然的。

API Object Models

API Object Models,简称AOM,AOM是一种设计模式,它围绕着将API、路由或功能交互及其相关行为封装在结构良好的对象中。AOM旨在增强API测试和集成的直观性和弹性。在实践中,AOM需要精心设计专门的API对象,以有效地保护用户免受与API 请求、响应、端点交互和身份验证过程相关的复杂性的影响。

基本概念

AOM基本用法

我们可以将业务高度关联的一组API封装为一个APIObject。例如,一个购物网站的API测试,我们可以创建一个OrderAPIObject来抽象化订单过程的复杂性。该对象封装了将商品添加到购物车、设置收件详细信息和下订单所需的API请求。测试脚本只需要与OrderAPIObject交互,从而简化了测试过程。

class OrderAPIObject:def add_item_to_cart(self, item_id: str):"""发出API请求和向购物车添加商品:param item_id::return:"""...def set_shipping_details(self, details):"""通过API请求设置收件信息:param details::return:"""...def place_order(self):"""下订单并接收确认:return:"""...

创建API对象技巧

为了创建强大的API对象,让我们进一步以OrderAPIObject为例。在此对象中,可以优雅地处理来自API的错误响应等场景。

class OrderAPIObject:def __init__(self):# 调用前置方法self.prepare_order()def prepare_order(self):"""准备下订单所需的项目和元素:return:"""...def place_order(self) -> dict:"""下订单,以及处理错误响应:return: OrderConfirmation ErrorResponse"""...

可以在下单之前,调用prepare_order()方法执行一些下单的前置工作。place_order()方法可以包含处理异常的响应,以及返回错误结果,以便测试保持弹性。

简单和灵活之间的平衡

任何设计模式的一个关键考虑因素是在简单性和灵活性之间找到适当的平衡。

例如,一个处理用户注册的API。在AOM 中,可以选择将用户注册数据作为单独的参数传递,或者将它们封装在User对象(或接口)中。选择取决于测试的可读性和可维护性要求。

class UserAPIObject:def register1(self, name: str, email: str, password: str):"""实现用户注册API:param name::param email::param password::return:"""...def register2(self, user: dict):"""实现用户注册API:param user::return:"""name = user.get("name", "")email = user.get("email", "")password = user.get("password", "")...

其中,register1()方法定义API所需要的每一个参数。当参数非常多时,也可以使用register2()方法直接接收dict对象。

AOM示例

通过模拟例子,演示基于AOM的接口自动化测试。

首先,定义APIObject层。

# shop_object.pyclass AuthAPIObject:def __init__(self, api_key):self.api_key = api_keydef get_token(self, user_id:str) -> str:"""模拟:根据用户ID生成登录token:param user_id::return:"""...class UserAPIObject:def __init__(self, token: str):self.token = tokendef get_user_data(self, user_id: str):"""模拟:根据用户ID查询用户信息:param user_id::return:"""...class ProductAPIObject:def __init__(self, token: str):self.token = tokendef get_product_data(self, product_id: str):"""模拟:根据产品ID查询产品信息:param product_id::return:"""...

以上非完整代码,说明如下。

•AuthAPIObject类用于封装用户认证相关接口,api_key参数用于接收接口的关键key。get_token()方法返回用户登录token。

•UserAPIObject类用于封装用户相关接口,调用接口需要登录token。get_user_data()方法,通过user ID查询用户数据。

•UserAPIObject类用于封装商品相关接口,调用接口需要登录token。get_product_data()方法,通过product ID查询商品数据。

然后,在用例中调用APIObject层。

import unittest
from shop_object import AuthAPIObject, UserAPIObject, ProductAPIObjectclass APITest(unittest.TestCase):def setUp(self) -> None:auth_api = AuthAPIObject("api_key_123")self.token = auth_api.get_token("user123")def test_user_info(self):"""用户信息查询接口"""user_api = UserAPIObject(self.token)user_data = user_api.get_user_data("tom123")self.assertEqual(user_data["name"], "tom")def test_product_info(self):"""商品信息查询接口"""product_api = ProductAPIObject(self.token)product_data = product_api.get_product_data("product123")self.assertEqual(product_data["name"], u"潮流T恤")if __name__ == '__main__':unittest.main()

总结

分层的好处立刻显现:

1.API只允许通过的APIObject进行封装,那么在封装之前可以检索一下是否有封装了,如果有,进一步确认是否满足自己的调用需求,我们一般在测试API的时候一般各种参数验证,当API作为依赖接口调用的时候,一般参数比较少且固定,所以,API在封装的时候要兼顾到这两种情况。

2.用例层只能通过APIObject的封装调用API,像登录token这种大部分接口会用到的信息,可以通过类初始化时传入,后续调用类下面方法的时候就不需要关心的。如果是多个接口组成一个场景,也可以再进行一层业务层的封装。

做好以上两点,就可以大大的减少代码冗余,后续维护起来也会方便很多。

你会发现 API Object 与 Page Object 思想基本一致,前者针对API测试,后者针对UI测试。

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!

相关文章:

API Object设计模式

API测试面临的问题 API测试由于编写简单,以及较高的稳定性,许多公司都以不同工具和框架维护API自动化测试。我们基于seldom框架也积累了几千条自动化用例。 •简单的用例 import seldomclass TestRequest(seldom.TestCase):def test_post_method(self…...

Python 爬虫:多进程,多线程爬虫<提高爬取效率>

关于多进程,多线程的知识,请自行查询资料补充 ~~~~~~~~~~~ 使用多进程: 在python中,使用多进程需要先导包: from threding import Threaddef work(name):for i in range(1000):print(f"我是线程:{n…...

什么是上拉电阻器?上拉和下拉电阻的典型应用

什么是上拉电阻器? 上拉电阻是逻辑电路中使用的电阻,用于确保引脚在所有条件下具有明确定义的逻辑电平。提醒一下,数字逻辑电路有三种逻辑状态:高、低和浮动(或高阻抗)。当引脚未被拉至高或低逻辑电平&…...

centos7安装python3.10

文章目录 1. 安装依赖项2. 下载Python 3.10源码3. 解压源码并进入目录4. 配置安装选项5. 编译并安装Python6. 验证安装7.创建软连接8. 安装pip39. 换源 1. 安装依赖项 sudo yum groupinstall -y "Development Tools" sudo yum install -y openssl-devel bzip2-devel…...

QT事件处理及实例(鼠标事件、键盘事件、事件过滤)

这篇文章通过鼠标事件、键盘事件和事件过滤的三个实例介绍事件处理的实现。 鼠标事件及实例 鼠标事件包括鼠标的移动、按下、松开、单击和双击等。 创建一个MouseEvent项目,通过项目介绍如何获得和处理鼠标事件。程序效果如下图所示。 界面布局代码如下&#xff…...

职场新人必备待办工具 高效待办工作更省心

作为一名初入职场的菜鸟,我曾被繁琐的工作任务压得喘不过气。每天,邮件、会议、项目任务像潮水般涌来,我常常感到力不从心,生怕遗漏了什么重要事项。那种焦虑,就像站在人来人往的地铁站,却不知道自己该搭乘…...

【创作纪念日】我的CSDN1024创作纪念

机缘 注册CSDN是很长时间了,但是上学时因为专业是电气工程,与编程打交道比较少,一直都是寻求帮助,而非内容输出。直到考研后专业改变,成为了主要跟软件编程、计算机知识相关的研究后,才逐步开启自己的CSDN…...

在AvaotaA1全志T527开发板上使用 UART 连接开发板

连接开发板 AvaotaA1提供两种连接串口输出方式,因为AvaotaA1需要DC 12V/2A/5.5-2.1电源适配器才可以启动系统,请先确保电源已接通。 方式一: 使用配套的 TyepC-SUB 转接板 40Gbps雷电线标准TypeC数据线,就可以同步实现 USB 串口…...

【Asterinas】Asterinas 进程启动与切换

Asterinas 进程启动与切换 进程启动 进程创建&#xff1a; Rust pub fn spawn_user_process( executable_path: &str, argv: Vec, envp: Vec, ) -> Result<Arc> { // spawn user process should give an absolute path debug_assert!(executable_path.starts_with…...

CVE-2024-6387 分析

文章目录 1. 漏洞成因2. 漏洞利用前置知识2.1 相关 SSH 协议报文格式2.2 Glibc 内存分配相关规则 3. POC3.1 堆内存布局3.2 服务端解析数据时间测量3.3 条件竞争3.4 FSOP 4. 相关挑战 原文链接&#xff1a;个人博客 近几天&#xff0c;OpenSSH爆出了一个非常严重的安全漏洞&am…...

STM32 ADC精度提升方法

STM32 ADC精度提升方法 Fang XS.1452512966qq.com如果有错误&#xff0c;希望被指出&#xff0c;学习技术的路难免会磕磕绊绊量的积累引起质的变化 硬件方法 优化布局布线&#xff0c;尽量减小其他干扰增加电源、Vref去耦电容使用低通滤波器&#xff0c;或加磁珠使用DCDC时尽…...

Redis为什么设计多个数据库

​关于Redis的知识前面已经介绍过很多了,但有个点没有讲,那就是一个Redis的实例并不是只有一个数据库,一般情况下,默认是Databases 0。 一 内部结构 设计如下: Redis 的源码中定义了 redisDb 结构体来表示单个数据库。这个结构有若干重要字段,比如: dict:该字段存储了…...

零基础学习MySQL---MySQL入门

顾得泉&#xff1a;个人主页 个人专栏&#xff1a;《Linux操作系统》 《C从入门到精通》 《LeedCode刷题》 键盘敲烂&#xff0c;年薪百万&#xff01; 一、什么是数据库 问&#xff1a;存储数据用文件就可以了&#xff0c;为什么还要弄个数据库呢&#xff1f; 这就不得不提…...

HUAWEI MPLS 静态配置和动态LDP配置

MPLS(Multi-Protocol Label Switching&#xff0c;多协议标签交换技术)技术的出现&#xff0c;极大地推动了互联网的发展和应用。例如&#xff1a;利用MPLS技术&#xff0c;可以有效而灵活地部署VPN(Virtual Private Network&#xff0c;虚拟专用网)&#xff0c;TE(Traffic Eng…...

【Rust】——所有的模式语法

&#x1f4bb;博主现有专栏&#xff1a; C51单片机&#xff08;STC89C516&#xff09;&#xff0c;c语言&#xff0c;c&#xff0c;离散数学&#xff0c;算法设计与分析&#xff0c;数据结构&#xff0c;Python&#xff0c;Java基础&#xff0c;MySQL&#xff0c;linux&#xf…...

基于Python的求职招聘管理系统【附源码】

摘 要 随着互联网技术的不断发展&#xff0c;人类的生活已经逐渐离不开网络了&#xff0c;在未来的社会中&#xff0c;人类的生活与工作都离不开数字化、网络化、电子化与虚拟化的数字技术。从互联网的发展历史、当前的应用现状和发展趋势来看&#xff0c;我们完全可以肯定&…...

Python23 使用Tensorflow实现线性回归

TensorFlow 是一个开源的软件库&#xff0c;用于数值计算&#xff0c;特别适用于大规模的机器学习。它由 Google 的研究人员和工程师在 Google Brain 团队内部开发&#xff0c;并在 2015 年首次发布。TensorFlow 的核心是使用数据流图来组织计算&#xff0c;使得它可以轻松地利…...

C++:枚举类的使用案例及场景

一、使用案例 在C中&#xff0c;枚举类&#xff08;也称为枚举类型或enum class&#xff09;是C11及以后版本中引入的一种更加强大的枚举类型。与传统的枚举&#xff08;enum&#xff09;相比&#xff0c;枚举类提供了更好的类型安全性和作用域控制。下面是一个使用枚举类的案…...

中英双语介绍美国的州:明尼苏达州(Minnesota)

中文版 明尼苏达州简介 明尼苏达州位于美国中北部&#xff0c;以其万湖之州的美誉、丰富的自然资源和多样化的经济结构而著称。以下是对明尼苏达州的详细介绍&#xff0c;包括其地理位置、人口、经济、教育、文化和主要城市。 地理位置 明尼苏达州东接威斯康星州&#xff0…...

Python实现万花筒效果:创造炫目的动态图案

文章目录 引言准备工作前置条件 代码实现与解析导入必要的库初始化Pygame定义绘制万花筒图案的函数主循环 完整代码 引言 万花筒效果通过反射和旋转图案创造出美丽的对称图案。在这篇博客中&#xff0c;我们将使用Python来实现一个动态的万花筒效果。通过利用Pygame库&#xf…...

java_网络服务相关_gateway_nacos_feign区别联系

1. spring-cloud-starter-gateway 作用&#xff1a;作为微服务架构的网关&#xff0c;统一入口&#xff0c;处理所有外部请求。 核心能力&#xff1a; 路由转发&#xff08;基于路径、服务名等&#xff09;过滤器&#xff08;鉴权、限流、日志、Header 处理&#xff09;支持负…...

边缘计算医疗风险自查APP开发方案

核心目标:在便携设备(智能手表/家用检测仪)部署轻量化疾病预测模型,实现低延迟、隐私安全的实时健康风险评估。 一、技术架构设计 #mermaid-svg-iuNaeeLK2YoFKfao {font-family:"trebuchet ms",verdana,arial,sans-serif;font-size:16px;fill:#333;}#mermaid-svg…...

Mybatis逆向工程,动态创建实体类、条件扩展类、Mapper接口、Mapper.xml映射文件

今天呢&#xff0c;博主的学习进度也是步入了Java Mybatis 框架&#xff0c;目前正在逐步杨帆旗航。 那么接下来就给大家出一期有关 Mybatis 逆向工程的教学&#xff0c;希望能对大家有所帮助&#xff0c;也特别欢迎大家指点不足之处&#xff0c;小生很乐意接受正确的建议&…...

多模态商品数据接口:融合图像、语音与文字的下一代商品详情体验

一、多模态商品数据接口的技术架构 &#xff08;一&#xff09;多模态数据融合引擎 跨模态语义对齐 通过Transformer架构实现图像、语音、文字的语义关联。例如&#xff0c;当用户上传一张“蓝色连衣裙”的图片时&#xff0c;接口可自动提取图像中的颜色&#xff08;RGB值&…...

省略号和可变参数模板

本文主要介绍如何展开可变参数的参数包 1.C语言的va_list展开可变参数 #include <iostream> #include <cstdarg>void printNumbers(int count, ...) {// 声明va_list类型的变量va_list args;// 使用va_start将可变参数写入变量argsva_start(args, count);for (in…...

LangFlow技术架构分析

&#x1f527; LangFlow 的可视化技术栈 前端节点编辑器 底层框架&#xff1a;基于 &#xff08;一个现代化的 React 节点绘图库&#xff09; 功能&#xff1a; 拖拽式构建 LangGraph 状态机 实时连线定义节点依赖关系 可视化调试循环和分支逻辑 与 LangGraph 的深…...

标注工具核心架构分析——主窗口的图像显示

&#x1f3d7;️ 标注工具核心架构分析 &#x1f4cb; 系统概述 主要有两个核心类&#xff0c;采用经典的 Scene-View 架构模式&#xff1a; &#x1f3af; 核心类结构 1. AnnotationScene (QGraphicsScene子类) 主要负责标注场景的管理和交互 &#x1f527; 关键函数&…...

Web APIS Day01

1.声明变量const优先 那为什么一开始前面就不能用const呢&#xff0c;接下来看几个例子&#xff1a; 下面这张为什么可以用const呢&#xff1f;因为复杂数据的引用地址没变&#xff0c;数组还是数组&#xff0c;只是添加了个元素&#xff0c;本质没变&#xff0c;所以可以用con…...

【向量库】Weaviate 搜索与索引技术:从基础概念到性能优化

文章目录 零、概述一、搜索技术分类1. 向量搜索&#xff1a;捕捉语义的智能检索2. 关键字搜索&#xff1a;精确匹配的传统方案3. 混合搜索&#xff1a;语义与精确的双重保障 二、向量检索技术分类1. HNSW索引&#xff1a;大规模数据的高效引擎2. Flat索引&#xff1a;小规模数据…...

第21节 Node.js 多进程

Node.js本身是以单线程的模式运行的&#xff0c;但它使用的是事件驱动来处理并发&#xff0c;这样有助于我们在多核 cpu 的系统上创建多个子进程&#xff0c;从而提高性能。 每个子进程总是带有三个流对象&#xff1a;child.stdin, child.stdout和child.stderr。他们可能会共享…...