API测试脚本开发实战指南：从基础到高级应用-编程实验室

API测试脚本开发实战指南：从基础到高级应用

【免费下载链接】bruno开源的API探索与测试集成开发环境（作为Postman/Insomnia的轻量级替代方案）项目地址: https://gitcode.com/GitHub_Trending/br/bruno

在当今快速迭代的软件开发环境中，API测试脚本开发已成为保证系统稳定性的关键技术。本文将深入探讨Bruno框架下的API测试脚本编写方法，通过问题导向的方式提供可落地的解决方案。

常见测试痛点及应对策略

问题一：复杂业务逻辑难以验证

场景描述：用户需要验证API返回的数据是否符合特定的业务规则，如订单状态流转、用户权限校验等。

解决方案：

function onResponse(request, response) { // 验证业务状态机 const orderStatus = response.json.data.status; expect(orderStatus).to.be.oneOf(['pending', 'processing', 'completed']); // 验证权限逻辑 const userRole = response.json.data.user.role; expect(userRole).to.satisfy((role) => { return ['admin', 'user', 'moderator'].includes(role); }); // 验证数据完整性 expect(response.json.data).to.have.all.keys([ 'id', 'status', 'amount', 'createdAt', 'updatedAt' ]); }

问题二：多请求间的数据依赖

场景描述：后续请求需要依赖前序请求的响应数据，如认证令牌、资源ID等。

解决方案：

function onResponse(request, response) { // 提取认证信息供后续请求使用 bruno.setVar('accessToken', response.json.access_token); bruno.setVar('userId', response.json.user.id); // 验证数据传递的正确性 expect(bruno.getVar('accessToken')).to.be.a('string').and.not.empty; }

核心测试框架深度解析

测试执行机制

Bruno的测试框架基于Chai断言库，其核心测试执行逻辑如下：

const Test = (__brunoTestResults, chai) => async (description, callback) => { try { await callback(); __brunoTestResults.addResult({ description, status: 'pass' }); } catch (error) { if (error instanceof chai.AssertionError) { __brunoTestResults.addResult({ description, status: 'fail', error: error.message, actual: error.actual, expected: error.expected }); } };

环境变量管理

环境变量在API测试中起到关键作用，Bruno提供了完整的环境变量管理机制：

class Bru { constructor(envVariables, runtimeVariables, processEnvVars, collectionPath) { this.envVariables = envVariables || {}; this.runtimeVariables = runtimeVariables || {}; this.processEnvVars = cloneDeep(processEnvVars || {}); this.collectionPath = collectionPath; // 持久化环境变量存储 this.persistentEnvVariables = {}; } setEnvVar(key, value, options = {}) { // 验证变量名合法性 if (!variableNameRegex.test(key)) { throw new Error(`变量名 "${key}" 包含无效字符`); } // 处理持久化变量 if (options?.persist && typeof value !== 'string') { throw new Error(`持久化环境变量必须是字符串类型`); } this.envVariables[key] = value; } }

高级测试脚本编写技巧

动态请求参数生成

在请求发送前动态生成参数，确保测试数据的时效性：

function onRequest(request) { // 生成时间戳 const timestamp = new Date().getTime(); request.params.timestamp = timestamp; // 计算签名 const apiSecret = bruno.getEnvVar('apiSecret'); const signature = crypto.createHash('md5') .update(`${timestamp}${apiSecret}`) .digest('hex'); request.params.signature = signature; }

响应数据验证模式

构建全面的响应验证体系：

function validateResponse(response) { // 基础状态验证 expect(response.status).to.equal(200); expect(response.responseTime).to.be.lessThan(1000); // 数据结构验证 expect(response.json).to.have.property('data'); expect(response.json.data).to.be.an('object'); // 业务规则验证 if (response.json.data.type === 'order') { expect(response.json.data).to.have.property('totalAmount'); expect(response.json.data.totalAmount).to.be.a('number').and.gt(0); } }

实战案例：电商API测试套件

用户认证流程测试

function onResponse(request, response) { // 验证认证响应 expect(response.status).to.equal(200); expect(response.json).to.have.property('token'); expect(response.json.token).to.be.a('string').and.not.empty; // 提取认证令牌 bruno.setVar('authToken', response.json.token); // 验证令牌格式 const tokenParts = response.json.token.split('.'); expect(tokenParts).to.have.lengthOf(3); // 设置后续请求 bruno.runner.setNextRequest('获取用户信息'); }

订单处理流程测试

function onResponse(request, response) { // 验证订单创建 expect(response.json.orderId).to.be.a('string'); // 存储订单ID供后续测试使用 bruno.setVar('orderId', response.json.orderId); }

测试脚本调试与优化

调试技巧

在脚本中插入调试信息：

function onResponse(request, response) { // 输出调试信息 console.log('响应状态:', response.status); console.log('响应时间:', response.responseTime); console.log('响应数据:', JSON.stringify(response.json, null, 2); }