Yingc站点

接口自动化的三层结构:数据、封装与编排

大部分自动化测试项目烂掉,不是因为用例写得少,而是因为用例和数据、请求逻辑搅在一起。改一个字段要动十几个文件,加一个接口要复制三份代码。

这篇文章讲一套已经被反复验证过的结构:数据、封装、编排三层分离。它不依赖特定框架,用 Pytest、JUnit 还是 Go test 都能落地。

先看反例

这是最常见的写法,也是最先崩掉的写法:

def test_create_user():
    resp = requests.post(
        "http://api.example.com/v1/users",
        json={"name": "张三", "email": "[email protected]", "role": "admin"},
        headers={"Authorization": "Bearer xxx", "Content-Type": "application/json"},
    )
    assert resp.status_code == 200
    assert resp.json()["data"]["name"] == "张三"
    uid = resp.json()["data"]["id"]

    resp2 = requests.delete(
        f"http://api.example.com/v1/users/{uid}",
        headers={"Authorization": "Bearer xxx"},
    )
    assert resp2.status_code == 200

这段代码能跑,但它有三个致命问题:

  • 地址、令牌、请求头硬编码,换环境就全挂
  • 业务数据混在代码里,想换一批测试数据要改代码
  • 创建和删除两条语句挤在一个函数里,删除失败时不知道是创建有问题还是删除有问题

三层分别管什么

把职责拆开之后,每层只关心一件事。

层 职责 不该做的事
数据层 提供入参、期望值、前置条件 不发请求、不写断言逻辑
封装层 拼接请求、签名、发 HTTP、解析响应 不做业务断言、不读测试数据文件
编排层 组织流程、断言、报告 不拼 URL、不写 JSON

数据层:只放数据

数据用 JSON 或 YAML,一份文件对应一组场景。关键点是数据里不能有逻辑。

{
  "create_user": {
    "valid": {
      "request": {"name": "张三", "email": "[email protected]", "role": "admin"},
      "expect": {"code": 200, "name": "张三"}
    },
    "duplicate_email": {
      "request": {"name": "李四", "email": "[email protected]", "role": "admin"},
      "expect": {"code": 409, "message": "邮箱已存在"}
    }
  }
}

这样加场景只需要改 JSON,不用碰代码。

封装层:把协议细节关起来

每个接口一个函数,统一签名、统一错误处理。

class UserAPI:
    def __init__(self, client):
        self.client = client

    def create(self, payload):
        return self.client.post("/v1/users", json=payload)

    def delete(self, user_id):
        return self.client.delete(f"/v1/users/{user_id}")

    def get(self, user_id):
        return self.client.get(f"/v1/users/{user_id}")

封装层不知道测试数据长什么样,也不知道断言规则。它只负责「把请求发出去,把响应拿回来」。

编排层:只写流程

真正读起来像测试用例的地方。

@pytest.mark.parametrize("case", load_cases("create_user"))
def test_create_user(api, case):
    resp = api.user.create(case["request"])
    assert resp.status_code == case["expect"]["code"]

    if case["expect"]["code"] == 200:
        uid = resp.json()["data"]["id"]
        detail = api.user.get(uid)
        assert detail.json()["data"]["name"] == case["expect"]["name"]
        api.user.delete(uid)

这段代码里没有一个 URL,没有一段 JSON,全是业务流程。读的人一眼就能看懂在测什么。

三个收益

换环境只改一处

地址和令牌收在 client 的初始化里,从配置文件读。测试代码不动。

失败定位快

创建失败和删除失败分属不同的断言,日志一眼能看出卡在哪一步。

用例可以批量生成

因为数据是独立的,可以用脚本批量生成边界值、异常值,不用手写。

常见误区

「三层」不是三个文件夹,而是三种职责。把代码按文件名分开、但逻辑还是混在一起,等于没分。

  • 过度封装:为每个字段写一个 getter,比直接访问还难读
  • 数据层塞逻辑:在 JSON 里写 if 表达式,最后没人看得懂
  • 编排层做请求:图省事直接在测试函数里写 requests,封装层就白建了

一句话总结

数据只描述「是什么」,封装只负责「怎么发」,编排只决定「先做什么后做什么」。三者边界清晰,项目才能活得久。

发表评论