自动化测试 / 系统课时

发送 API 请求

发送 API 请求

本课解决测试中需要绕过页面直接调用接口的问题。学习完成后,可以使用 Playwright 请求上下文发送 GET、POST、PUT 和 DELETE 请求,并通过状态码和响应数据验证接口行为,还可以使用 API 为 UI 测试准备数据。

学习目标

  • 理解 API 请求上下文及其与页面请求的区别。
  • 掌握 GET、POST、PUT 和 DELETE 请求的发送方式。
  • 编写接口自动化测试,验证响应状态和 JSON 数据。

APIRequestContext 机制

Playwright 提供独立请求客户端,可以在不打开页面的情况下完成接口测试,也可以配合 UI 测试准备数据。

在 Playwright Test 中,request 夹具提供一个 APIRequestContext 实例。测试代码通过它发送 HTTP 请求,服务端返回响应后,可以使用 APIResponse 的方法读取状态码、响应头和响应体。

典型的接口测试包含以下环节:

  1. 使用 request.get()、request.post() 等方法发送请求。
  2. 等待服务端返回 APIResponse。
  3. 使用 response.status() 检查 HTTP 状态码。
  4. 使用 response.json() 解析 JSON 响应体,再断言关键业务字段。

Playwright API 请求上下文与请求响应数据流

需要注意,Playwright Test 的 request 夹具默认具有独立的 Cookie 存储,不会自动继承页面登录状态。如果需要通过 API 复用当前页面的登录会话,可以使用 page.request,它与对应的浏览器上下文共享 Cookie。

发送接口请求

下面使用 JSONPlaceholder 公开演示接口完成一次 GET、POST、PUT 和 DELETE 请求测试。该服务支持模拟创建、更新和删除操作,适合练习 HTTP 方法,但不会持久化这些修改。

在已经安装 @playwright/test 的项目中,新建 tests/api.spec.js,写入以下代码:

javascript
const { test, expect } = require('@playwright/test');

test('api request', async ({ request }) => {
  const baseUrl = 'https://jsonplaceholder.typicode.com/posts';

  // GET 读取已有资源,验证状态码和关键字段
  const getRes = await request.get(`${baseUrl}/1`);
  expect(getRes.status()).toBe(200);
  const getData = await getRes.json();
  expect(getData.id).toBe(1);

  // POST 的 data 对象会被序列化为 JSON
  const postRes = await request.post(baseUrl, {
    data: { title: 'draft', body: 'playwright', userId: 1 },
  });
  expect(postRes.status()).toBe(201);
  const postData = await postRes.json();
  expect(postData.title).toBe('draft');

  // PUT 提交资源的完整更新内容
  const putRes = await request.put(`${baseUrl}/1`, {
    data: { id: 1, title: 'updated', body: 'playwright', userId: 1 },
  });
  expect(putRes.status()).toBe(200);
  const putData = await putRes.json();
  expect(putData.title).toBe('updated');

  // DELETE 验证接口响应,不假设演示服务真实删除数据
  const deleteRes = await request.delete(`${baseUrl}/1`);
  expect(deleteRes.status()).toBe(200);

  console.log(
    `GET=${getRes.status()} POST=${postRes.status()} PUT=${putRes.status()} DELETE=${deleteRes.status()}`
  );
});

在项目根目录执行 npx playwright test tests/api.spec.js。四个请求均通过断言时,测试日志中应包含以下内容。

预期输出:

text
GET=200 POST=201 PUT=200 DELETE=200

Playwright Test 还会显示测试通过数量和运行耗时。如果接口返回的数据或状态码不符合断言,测试会失败并标出对应的 expect 语句。

这个示例既检查 HTTP 状态码,也检查 JSON 中的 id 和 title 字段。只检查状态码可能漏掉业务数据错误,因此应选择能够代表接口业务契约的关键字段进行断言。

常见请求类型

GET 用于读取资源,POST 通常用于创建资源,PUT 通常用于完整替换资源,DELETE 用于删除资源。测试时可以先通过 API 创建数据,再进入页面验证。

这些请求方法的主要区别如下:

方法 典型用途 本例请求地址 本例预期状态码
GET 查询资源 /posts/1 200
POST 创建资源 /posts 201
PUT 更新资源 /posts/1 200
DELETE 删除资源 /posts/1 200

表中的状态码对应本例演示接口,并不是所有 API 的统一返回规则。例如,成功删除资源也可能返回 204,具体应以被测接口的契约为准。

发送 POST 或 PUT 请求时,可以通过 data 传递 JavaScript 对象。Playwright 会将其序列化为 JSON,并设置相应的 Content-Type 请求头。接口需要身份验证时,可以通过请求选项中的 headers 设置 Authorization 等请求头。

请求选项还支持 params、timeout 等参数。例如,timeout: 10000 表示将该请求的超时时间设置为 10000 毫秒。实际项目应根据接口响应时间和测试环境选择合适的超时值。

验证响应与处理边界

接口测试不能只验证请求成功发出,还需要检查响应是否符合预期。建议按照以下顺序判断:

  1. 状态码:使用 response.status() 确认 HTTP 结果,例如 200、201 或 204。
  2. 响应数据:对于返回 JSON 的接口,使用 response.json() 解析响应,并断言必要字段。
  3. 业务结果:对于真实可持久化的创建、修改和删除操作,通过后续查询确认数据状态确实发生变化。

需要特别注意,服务器返回 400、404 或 500 时,Playwright 的请求方法默认不会仅因为 HTTP 错误状态而抛出异常。因此,应明确断言状态码,避免把收到错误响应误判为测试通过。

如果接口返回 204 No Content,就不要调用 response.json(),因为响应体为空,JSON 解析会失败。对于返回非 JSON 内容的接口,应根据响应类型使用 response.text() 或其他适合的方法读取。

在实际 UI 自动化测试中,可以先通过 API 创建临时用户或订单,取得返回的资源 ID,再打开页面检查对应内容。测试结束后,应使用清理接口删除测试数据,避免多次运行相互影响。不要直接使用生产环境执行会修改或删除业务数据的接口测试。

通过以上方式,可以将接口请求、状态检查、数据断言和测试数据准备组合起来,用同一个 Playwright 测试框架覆盖 API 与页面两个层面的验证。

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

目录与阅读设置

阅读设置

17

记录一个想法

发送 API 请求

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

登录哪都通