自动化测试 / 系统课时

实现接口与页面联测

实现接口与页面联测

接口与页面联测最适合验证“后端状态已经存在,前端能否正确读取并呈现”这类跨层流程。本节使用 Playwright 的 APIRequestContext 先通过 API 创建测试数据,再打开浏览器验证页面,最后清理数据,形成可重复执行的完整闭环。

学习目标

  • 用 Playwright API 请求快速准备页面测试所需的业务数据
  • 让 API 建数与浏览器验证指向同一环境并保持数据关联
  • 处理认证共享、并发唯一性和测试后清理等联测边界

把 API 和页面分成两个职责

联测时,API 的主要价值是准备前置状态,浏览器负责验证用户真正看到的结果。例如要验证“任务详情页能展示已存在任务”,通过 API 创建任务比在 UI 中逐步填写表单更快,也能减少与当前目标无关的页面步骤。

API 准备数据并通过页面验证的联测时序

这类测试的关键不是同时出现 HTTP 和浏览器代码,而是二者必须围绕同一个业务实体。API 返回的 id 应直接驱动页面地址或后续操作,避免 API 创建一条数据、页面却验证另一条固定数据。

约定可验证的业务契约

下面示例假设测试环境提供三个契约:POST /api/tasks 创建任务并返回 201 和任务 JSON;GET /tasks/:id 展示任务详情页;DELETE /api/tasks/:id 用于清理测试数据。创建响应至少包含 id、title、status。

如果真实系统的路径、字段或状态码不同,应以实际 API 契约为准,而不是为了迁就测试硬编码错误预期。联测用例应使用专用测试环境,并确保 API 创建的数据能被页面访问到。

用 API 建数,再用页面验收

先让页面导航和 API 请求共享同一个基础地址。playwright.config.ts 是配置文件示例,不单独执行。

ts
import { defineConfig } from '@playwright/test';

export default defineConfig({
  testDir: './tests',
  use: {
    // page.goto() 与内置 request Fixture 都以同一测试环境为目标。
    baseURL: process.env.APP_BASE_URL ?? 'http://127.0.0.1:3000',
    trace: 'on-first-retry',
  },
});

生效行为:相对页面地址和相对 API 地址都会解析到测试环境。可通过设置 APP_BASE_URL 在本地、预发或 CI 环境间切换,而无需改测试代码。

tests/task-flow.spec.ts 使用内置 request Fixture 创建数据,并用返回的 id 打开对应页面。try...finally 确保页面断言失败时仍尽力清理已创建的数据。

ts
import { test, expect } from '@playwright/test';

type Task = {
  id: string;
  title: string;
  status: 'open' | 'done';
};

test('API 创建的任务能在详情页正确展示', async ({ request, page }) => {
  const title = `e2e-task-${test.info().parallelIndex}-${Date.now()}`;
  let taskId: string | undefined;

  try {
    // API 只负责准备当前页面场景需要的前置数据。
    const createResponse = await request.post('/api/tasks', {
      data: { title, status: 'open' },
    });

    expect(createResponse.status()).toBe(201);
    const task = (await createResponse.json()) as Task;
    expect(task.id).toBeTruthy();
    expect(task.title).toBe(title);
    taskId = task.id;

    // 页面验证复用 API 返回的实体标识,保证验证的是同一条数据。
    await page.goto(`/tasks/${taskId}`);
    await expect(page.getByRole('heading', { name: title })).toBeVisible();
    await expect(page.getByText('open', { exact: true })).toBeVisible();
  } finally {
    if (taskId) {
      await request.delete(`/api/tasks/${taskId}`);
    }
  }
});

预期结果:创建接口返回 201 和有效 id 后,浏览器打开同一任务的详情页,页面能显示唯一标题与 open 状态;无论页面断言成功或失败,只要已经取得 taskId,清理请求都会执行。

运行联测:

bash
npx playwright test tests/task-flow.spec.ts

预期输出:

text
Running 1 test using 1 worker
  ✓ API 创建的任务能在详情页正确展示
  1 passed (<TIME>)

实际耗时可能不同,因此用 <TIME> 表示动态值。若测试失败,应先查看创建接口状态码和响应体,再确认页面请求的实体 id 与 API 返回值一致。

处理认证与并发边界

内置 request Fixture 是独立的 APIRequestContext。如果建数接口使用独立测试令牌,它很合适;如果 API 必须复用当前浏览器已经获得的登录 Cookie,则应改用 page.request 或 page.context().request,因为它们与当前 BrowserContext 共享 Cookie 存储。

并行执行时,不要让多个用例争抢同一个固定名称或固定账号。示例把 parallelIndex 和当前时间写入标题,就是为了降低数据碰撞。更严格的系统可以由后端测试工厂生成唯一 ID,并把该 ID 贯穿创建、页面验证和清理全过程。

清理逻辑同样属于测试可靠性的一部分。不要依赖“测试通过后再手动删数据”,也不要让清理失败悄悄污染后续用例;在成熟项目中,可以把建数与清理进一步封装成专用 Fixture,让生命周期规则集中管理。

判断什么时候不该用 API 绕过页面

API 建数只适合跳过与当前目标无关的前置步骤。如果要验证的业务本身就是“用户在页面创建任务”,就不能先用 API 创建任务再声称 UI 创建流程已被覆盖;这会绕过表单校验、按钮行为和提交请求等真正需要测试的路径。

一个稳妥的判断方法是先写出本次验收动作:若目标是“已有任务能被正确展示”,API 建数是加速器;若目标是“用户能通过页面成功创建任务”,创建动作必须走浏览器。这样接口与页面联测才能既快,又不牺牲业务覆盖的真实性。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

实现接口与页面联测

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通