接口测试框架实战(三) | APIObject 模式、原则与应用

APIObject模式在接口测试框架的应用实战
最新推荐文章于 2025-02-08 17:11:42 发布
原创 最新推荐文章于 2025-02-08 17:11:42 发布 · 653 阅读 · 3 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#软件测试 #测试工程师

本文介绍了APIObject设计模式在接口测试中的应用，通过企业微信部门管理接口为例，展示从无封装到使用APIObject模式的封装改造过程。文章详细讲解了APIObject的6个模块，并提供了环境准备、接口测试框架、文件结构和具体实现的思路，旨在帮助读者深入理解并实践APIObject设计模式。

本文节选自霍格沃玆测试学院内部教材，文末链接进阶学习。

APIObject 模式与原则
在普通的接口自动化测试中，如果接口的参数，比如 url，headers 等传参改变，或者测试用例的逻辑、断言改变，那么整个测试代码都需要改变。APIObject 设计模式借鉴了 PageObject 的设计模式，可以实现一个优雅、强大的接口测试框架。

理念

APIObject 设计模式可以简单分为 6 个模块，分别是 API 对象、接口测试框架、配置模块、数据封装、Utils、测试用例。

  • 接口测试框架：base_api，完成对 API 的驱动
  • API 对象：继承 base_api 后，完成对接口的封装
  • 配置模块：完成配置文件的读取
  • 数据封装：数据构造与测试用例的数据封装
  • Utils：其他功能封装，改进原生框架不足
  • 测试用例：调用 Page/API 对象实现业务并断言

枯燥的讲述概念可能难以理解，后面的章节都会围绕这个6个模块进行理论的拆解和实例的演示。

APIObject 模式应用

本章将结合企业微信的部门管理，获取部门列表接口作为一个接口测试用例，从没有封装到使用APIObject 设计模式进行封装改造。将实战与理论结合，更深入理解 APIObject 设计模式。

环境准备

企业微信服务端 API：
https://work.weixin.qq.com/api/doc/90000/90135/90664
不加任何封装和改造的企业微信，获取部门列表接口测试用例：

import requests


class TestDemo:

    def test_get_token(self):
        r = requests.get(url="https://qyapi.weixin.qq.com/cgi-bin/gettoken",
            params={
   
   "corpid": "ww93348658d7c66ef4", "corpsecret": "T0TFrXmGYel167lnkzEydsjl6bcDDeXVmkUnEYugKIw"})
        return r.json()["access_token"]

    def test_department_list(self):
        r = requests.get(url=
最低0.47元/天 解锁文章
接口测试框架1之接口测试框架简介、加密接口案例、多环境运行接口、ApiObject模式
weixin_49855251的博客
06-10 1048
目录：一、接口流程的封装和定义二、基于加密接口测试用例设计三、多环境下的接口测试四、ApiObject模式与原则api object模式的应用：通用api封装 一、接口流程的封装和定义 配置： 根据配置文件获取初始配置和依赖 接口封装 封装接口调用进行抽象封装 类似PageObject效果 业务流程 业务用例设计，含有多个api形成的流程定义，不要在包含任何接口实现细节 断言 1、测试框架包含 API对象，完成对接口的封装 接口测试框架，完成对api的驱动 配置模块，完成对配置文件的读取 数据封装，数据构造
ApiObject
yy1711408814的博客
03-07 522
 /** *Object 根类 中的常见方法说明：Object类型是java世界中所有类型的根类 *  所有的类型，直接或者间接继承 Object类型 *   *  常用方法： *  inthashCode():返回对象的哈希值，常用来判断两个对象是否相等。 *  finalClass getClass()： 返回当前对象的所属类的名称字符串表示形式 * String toString()：返回该...
API Object设计模式
主要分享测试的学习资源，帮助快速了解测试行业，帮助想转行、进阶、小白成长为高级测试工程师。
02-23 1037
API测试面临的问题 API测试由于编写简单，以及较高的稳定性，许多公司都以不同工具和框架维护API自动化测试。我们基于seldom框架也积累了几千条自动化用例。
API Object
weixin_70773268的博客
06-08 308
什么是API Object
接口测试框架实战 | 流程封装与基于加密接口的测试用例设计
阿里大叔说测试的博客
08-16 497
首先需要明确在面对一个加密的响应结果，可以使用什么样的处理方式：如果知道使用的是哪个通用加密算法的话，可以自行解决。如果不了解对应的加密算法的话，可以让研发提供加解密的 lib。如果既不是通用加密算法、研发也无法提供加解密的 lib 的话，可以让加密方提供远程解析服务，这样算法仍然是保密的。本文主要讲的是在了解使用加密算法的情况下，如何处理这样的解密算法。但是封装的思路都是相通的，不管是面对哪种情况，都可以通过格式化的数据，指明数据的内容，并通过一层逻辑的封装，将加解密或者选择的协议封装进去。
接口测试框架实战(四) | 通用 API 封装实战
weixin_46635091的博客
10-12 302
本文节选自霍格沃玆测试学院内部教材，文末链接进阶学习。 在 APIObject 设计模式中，需要一个 base_api 作为其他 API 步骤的父类，把通用功能放在这个父类中，供其他的 API 直接继承调用。这样做的优点在于，减少重复代码，提高代码的复用性。 通用 API 封装实战 在上一章节在演示使用 API-Object 设计模式对脚本进行改造时提到了 base_api。不过在上一章，仅仅只是封装了一个 utils 中的一个简单方法。并没有完全体现出 base_api 的实际作用。 接下来，我们通过.
接口自动化测试框架实战-2-项目接口文档
米兔软件测试
07-23 1589
上一小节我们完成了项目开发环境的搭建，本小结我们具体介绍一下项目中使用到的接口文档。
API——Object类
zhaomanl的博客
08-17 306
API API---Application Programming Interface（提供一系列的接口以及接口下的类） API里提供的所有方法要么被protected修饰要么就是不写（public） Object 1.概念 Object类是java的顶级父类，每个类默认继承Object类。 class A extends B{} class B extends Object{} 没有违背类的单一继承原则 2.重要方法 1.clone():把原对象的熟悉值赋值到新对象中并且把新对象...
常见的API方法之Object（一）
qq_32329745的博客
06-04 644
常见的API方法之Object（一） clone():此方法的用途是用来另存一个当前存在的对象。 public class CloneTest { public static void main(String[] args) throws CloneNotSupportedException { People s1 = new People("yhl...
Python接口自动化测试之apiobject设计模式day02
qq_45948176的博客
01-26 417
切换pytest环境，在pycharm–file–settings–tools–python–integrated tools中右侧的Testing下Default test runner下拉框中选择pytest即可。可以通过pycharm安装，可以在pycharm中的file–settings–project,项目名下的python。同时添加多个@pytest.mark.parametrize装饰器，多个parametrize的左右元素。下载requests的命令。下载pytest的命令。
API和object
qq_39027486的博客
08-12 205
如何阅读API 1.看该类在哪个包下 2.看层次结构关系 3.看类属于哪种类型 普通类 看构造方法 抽象类 a.看子类 b.看是否有静态方法返回本类的对象 getInstance 接口 看实现类 4.看类的描述 Object Class – 万事万物皆是对象,Java生成的字节码文件也是一个对象,这个Cl...
常用API之object
buith9879的博客
01-29 164
想要深克隆（除了String类其他引用数据类型创建一个新的再复制）可以自己重写或者调用工具。equals():比较对象时会重写，比较对象属性值是否相同。不重写的话比较地址值，重写比较属性值。toString():一般会重写，打印对象时打印属性。不重写返回地址值，重写返回内容。Object是java中的顶级父类，所有的类都直接或者间接的继承于Object类。equals(对象1，对象2)：先做非空判断，比较两个对象。Objects是一个工具类，提供了一些操作对象的方法。nonNull：判断对象是否不空。
14.1 Java的API及obje
southdreams的博客
05-11 383
Java的API:Java 的API（API: Application(应用) Programming(程序) Interface(接口)）Java API就是JDK中提供给我们使用的类，这些类将底层的代码实现封装了起来，我们不需要关心这些类是如何实现的，只需要学习这些类如何使用即可。在JDK安装目录下有个src.zip文件，这个文件解压缩后里面的内容是所有Java类的源文件。可以在其中查看相对应...
[java] API-Object、Objects篇
2301_77946674的博客
02-08 727
常用的API
API中的Object类知识点
杜圆圆的博客
08-20 329
API—Application Programming Interfaces（提供一系列的接口以及接口下的类） API里提供的所有方法要么是被protected修饰要么就是不写（public） 1.概念 Object类是java的顶级父类，每个类默认继承Object类。 2.重要方法 1.clone():把原对象的属性值赋值到新对象中并且把新对象进行返回类实现Cloneable接口产生对象才能支持克隆操作 package cn.tedu.object; //当类实现Cloneable接口产生的对象就能支
API之Object类
没有所谓的命运，只有不同的选择！
11-22 558
Object 类 Object类是Java语言中的根类，也就是所有类中的父类，它的所有方法子类都可以使用，所有类在创建的时候，最终找的父类就是Object类。找不到一个类的父类不是Object类。Object类的方法中，用的比较多的就equals方法和toString方法。 方法： 1、equals方法： 此方法用比较两个对象是否相同，其实就是用两个
API常用类之Object类
Barbiz的博客
12-10 244
Object类是所有Java类的祖先（根基类）。每个类都使用 Object 作为超类（父类）。所有对象（包括数组）都实现这个类的方法。 如果在类的声明中未使用extends关键字指明其基类，则默认基类为Object类 public class Person { ... } 等价于：public class Person extends Object { ... } toString方法 Object类中定义有public String toString()方法，其返回值是 String类型，描述当
Object类介绍
dianmei3204的博客
05-09 218
(1)Object是类层次结构的根类，所有的类都直接或者间接的继承自Object类。 (2)Object类的构造方法有一个，并且是无参构造 这其实就是理解当时我们说过，子类构造方法默认访问父类的构造是无参构造 (3)要掌握的方法： A:toString() 返回对象的字符串表示，默认是由类的全路径+'@'+哈希值的十六...
接口测试框架实战
最新发布
10-12
<think>我们注意到用户想要获取关于“接口测试框架实战案例及方法”的内容。根据引用内容，我们可以整合以下信息： 引用[1]提到： - 使用requests库进行接口测试并处理复杂场景 - 利用unittest框架组织和执行测试用例 - 采用数据驱动测试策略 引用[2]强调了接口文档测试的关键点： - 确保开发提供完整接口文档（URL/方法/Header/参数等） - 检查接口设计规范（命名/格式/状态码/容错等） 引用[3]则是推广内容，无实质技术信息。 因此，我们将重点构建基于Python的接口测试框架实战方案，包含以下核心模块： 1. 基础请求模块（requests封装） 2. 测试用例管理（unittest） 3. 数据驱动实现 4. 接口文档校验方法 下面开始具体实现： </think>### 接口测试框架实战案例与方法 #### 一、接口测试框架核心组件 基于引用内容[1][2]，完整的接口测试框架需包含以下模块： 1. **请求封装层**：使用 `requests` 库封装 HTTP 请求 ```python import requests class RequestClient: def __init__(self, base_url): self.base_url = base_url def send_request(self, method, endpoint, params=None, json=None, headers=None): url = f"{self.base_url}{endpoint}" return requests.request(method, url, params=params, json=json, headers=headers) ``` 2. **测试用例管理**：通过 `unittest` 组织用例（引用[1]） ```python import unittest class APITestCase(unittest.TestCase): @classmethod def setUpClass(cls): cls.client = RequestClient("https://api.example.com") def test_user_login(self): response = self.client.send_request("POST", "/login", json={"username": "test", "password": "123456"}) self.assertEqual(response.status_code, 200) self.assertIn("token", response.json()) ``` 3. **数据驱动测试**：使用 `ddt` 实现（引用[1]） ```python import ddt @ddt.ddt class DataDrivenTest(unittest.TestCase): @ddt.data( {"query": "apple", "expected_count": 15}, {"query": "banana", "expected_count": 8} ) @ddt.unpack def test_search_api(self, query, expected_count): response = self.client.send_request("GET", "/search", params={"q": query}) self.assertEqual(len(response.json()["results"]), expected_count) ``` #### 二、实战优化技巧 1. **接口文档验证**（引用[2]关键点） - 校验必填项：使用 `jsonschema` 验证响应结构 ```python from jsonschema import validate schema = { "type": "object", "properties": { "code": {"type": "integer"}, "data": {"type": "object"} }, "required": ["code", "data"] } def test_response_schema(self): response = self.client.send_request("GET", "/user/1") validate(instance=response.json(), schema=schema) ``` 2. **稳定性增强** - 重试机制处理偶发失败 ```python from tenacity import retry, stop_after_attempt @retry(stop=stop_after_attempt(3)) def call_flaky_api(): return requests.get("https://api.example.com/flaky-endpoint") ``` 3. **持续集成集成** - 结合 Jenkins/GitHub Actions 实现自动化执行 #### 三、典型实战案例 **电商订单场景测试链** ```python class OrderWorkflowTest(unittest.TestCase): def test_order_workflow(self): # 1. 登录获取token login_res = self.client.send_request("POST", "/login", json={"user": "test"}) token = login_res.json()["token"] # 2. 创建订单 order_res = self.client.send_request( "POST", "/orders", json={"product_id": 100}, headers={"Authorization": f"Bearer {token}"} ) order_id = order_res.json()["order_id"] # 3. 支付校验 pay_res = self.client.send_request( "POST", f"/orders/{order_id}/pay", headers={"Authorization": f"Bearer {token}"} ) self.assertEqual(pay_res.json()["status"], "PAID") ``` #### 四、关键注意事项 1. **接口文档规范**（引用[2]核心要求） - 强制要求提供包含以下内容的文档： $$ \text{文档要素} = \left\{ \begin{array}{c} \text{URL} \\ \text{请求方法} \\ \text{Header 规范} \\ \text{入参结构} \\ \text{返回值定义} \\ \text{状态码说明} \end{array} \right\} $$ 2. **安全测试扩展** - 增加 SQL 注入测试：`/search?q=' OR 1=1--` - 敏感数据加密验证 --- ### 相关问题 1. 如何处理接口测试中的动态令牌认证？ 2. 如何设计可维护的接口测试数据工厂？ 3. 接口性能测试应该关注哪些核心指标？ 4. 微服务架构下如何实现契约测试？ > 引用说明： > [^1]: Python接口测试实战案例与技巧 > [^2]: 接口文档测试规范要点
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值