Apifox规范要求统一接口定义、分级管理环境变量、结构化测试用例、严格管控Mock启用边界,并集成自动化测试与CI/CD。接口须在「接口管理」完整定义,全局变量仅存基础值,环境变量按角色隔离并加密敏感字段,测试用例需业务化命名、多断言、数据驱动且禁止单接口调试,Mock仅用于前端开发且须与真实Schema一致,自动化测试须定时执行并阻断失败合并。

团队完成Postman和Swagger数据迁移后,最常遇到的问题是成员仍沿用旧习惯:有人在接口定义里写测试脚本,有人把Mock规则塞进环境变量,还有人直接在测试套件里硬编码参数——这会让Apifox的协同优势迅速瓦解。
建立统一的接口定义规范
所有接口必须在「接口管理」模块中定义,禁止在测试用例或Mock配置中反向补全字段。
每个接口的「请求参数」区域需完整填写:必填项打勾、类型明确标注(string/integer/boolean)、示例值用真实业务数据。
描述栏必须用中文写清业务含义,例如“user_id:用户在核心系统的唯一标识,非登录账号”,【跳过此步会导致后续自动生成的文档无法被测试同事准确理解】。
接口路径末尾不加斜杠,如 /api/v1/users 而非 /api/v1/users/ —— 这会影响Mock服务的路由匹配精度。
环境与变量的分级管理
方法一:全局变量只存基础不变量
在「项目设置→全局变量」中仅配置 base_url、app_version、tenant_id 这类跨环境一致的值。其他动态值一律不放这里。
方法二:环境变量按角色隔离
创建三个标准环境:dev(开发联调)、test(测试验收)、prod(预发布)。每个环境变量只填该环境独有的配置,例如 dev 的 base_url 是 http://localhost:8080,test 的是 https://api-test.example.com。
方法三:敏感字段强制加密
密码、密钥、token 等字段必须勾选「加密」开关,【未加密的敏感变量一旦同步到团队空间,所有成员均可查看原始值】。
测试用例组织与执行流程
第一步:用业务动词命名测试用例
不叫“login_test_01”,而叫“用户使用手机号+验证码成功登录”。命名即文档,避免二次解释。
Apifox Linux 桌面版是一款专为 Linux 开发者打造的 API 一体化工具,集接口设计、调试、测试、Mock 和文档管理于一体。它在 Linux 环境下提供稳定、高效的本地运行体验,帮助开发者实现 API 全生命周期管理,是 Linux 开发者进行接口开发与联调的高效工具。
第二步:断言必须覆盖状态码+关键响应字段
除 apt.assert('response.status === 200') 外,至少再加一条如 apt.assert('response.body.data.token !== undefined', '返回token字段')。
第三步:参数化走「数据驱动」不走「复制粘贴」
需要测多组手机号,就新建一个CSV文件上传到「数据源」,在用例中绑定变量 {{phone}},而不是手动复制5个相同用例改参数。
第四步:禁用「单接口调试」模式执行回归
所有回归测试必须通过「测试套件」运行,确保前置接口(如登录)已执行且 token 已注入后续请求头。
Mock服务的启用边界
前端开发阶段开启 Mock,但必须满足两个前提:接口已在「接口管理」中定义完毕、Mock 响应结构与真实接口返回 JSON Schema 严格一致。
Mock 规则只配置在「接口详情页→Mock」标签下,严禁在测试用例的「前置脚本」里拼接假响应。
当后端接口可连通时,立即关闭对应接口的 Mock 开关——长期开着会掩盖真实环境下的字段缺失或类型错误。
自动化测试与CI/CD集成
在「测试套件」中启用「定时执行」,设置每天凌晨3点自动跑全量冒烟测试,失败结果实时推送企业微信机器人。
CI流水线中接入Apifox CLI,在代码合并到main分支前触发指定套件,【失败则阻断合并,不设重试次数】。
每次发布版本前,导出「测试报告」PDF,包含通过率、平均响应时间、慢接口TOP5,作为上线评审材料之一。

















