数据模板使用文档
面向使用者的操作指南。菜单位置:接口测试 → 数据模板。 数据模板用于定义可复用的结构化数据生成规则(如「用户信息」「订单数据」),在接口请求、Mock 响应、脚本中引用,解决构造测试数据的问题。
一、页面布局
- 左侧:文件夹 + 模板混合树。顶层为虚拟「根目录」(视为文件夹),支持右键新建文件夹/模板、拖拽调整层级和顺序、搜索(命中高亮);文件夹节点显示所含模板数量
- 右侧:选中模板的内联编辑区(基本信息 + 字段规则)和生成预览区(上下可拖拽分栏)
二、模板管理
2.1 新建模板
左树「根目录」或任意文件夹右键 →「新建模板」。新模板自动预置两个示例字段(id: UUID、name: 中文姓名),可直接修改。
填写:名称、描述、所属文件夹、共享范围。
2.2 编辑字段规则
每个字段配置:字段名、字段类型、Mock 规则、规则参数;OBJECT/ARRAY 类型可展开子字段。规则支持 JSON 导出/导入,方便跨模板复用。
编辑中有未保存更改时,切换模板/新建/切项目会弹确认提示。
2.3 复制 / 删除
- 模板右键「复制」:生成
原名称 副本(重名自动加序号),复制后自动选中 - 删除文件夹会递归删除其下所有子文件夹和模板,请谨慎操作
- 字段规则选「数据模板」类型时不会列出当前编辑的模板(防止循环引用)
三、字段规则参考
3.1 字段类型
| 类型 | 说明 | 子字段 |
|---|---|---|
| STRING / INT / FLOAT / BOOLEAN | 标量 | 无 |
| OBJECT | JSON 对象 | 有 |
| ARRAY | JSON 数组,可配置长度;元素为对象时展开子字段 | 有/无 |
3.2 常用规则
| 分类 | 规则 | 参数 |
|---|---|---|
| 个人信息 | 姓名(中/英)、中文姓名、英文姓名、手机号、邮箱、身份证、银行卡 | 姓名可选中文/英文 |
| 数字 | 整数、长整数、浮点、双精度 | 最小值、最大值(浮点另有小数位) |
| 字符串 | UUID、随机字符串(长度)、随机字符(字符集+长度) | |
| 日期时间 | 日期、日期时间、时间(格式)、时间戳(s/ms/ns) | |
| 基础 | 固定值、枚举选择(逗号分隔选项)、布尔 | |
| 组织 | 公司名、地址(中/英文) | |
| 引用 | 数据模板(引用另一个模板生成) | 模板 ID |
四、生成与导出
- 单条预览:实时生成一条样例数据(JSON 展示)
- 批量生成:指定数量,单次最多 1000 条
- 导出:批量结果可导出 JSON / CSV / Excel
五、引用方式
5.1 在请求参数 / Body 中
点击参数表格的 Mock 按钮,选「数据模板」规则并指定模板;参数值显示为 @template(123)。
Body 原始 JSON 中可直接写表达式:
json
{
"user": "{{__TEMPLATE(123)__}}",
"users": "{{__TEMPLATE_BATCH(123, 5)__}}"
}也可用 Body 编辑器的「插入模板数据」按钮,选择模板和生成方式后自动插入。
5.2 在 Mock 响应中
Mock 字段规则中选择「数据模板」规则,指定模板 ID 即可嵌套生成。
5.3 在脚本中
javascript
// 单条
const userJson = context.utils.template(123);
context.setVariable("user", userJson);
// 批量
const usersJson = context.utils.templateBatch(123, 10);
context.setVariable("users", usersJson);
// 任意 Mock 类型
context.setVariable("phone", context.utils.mock("phone"));配合 ${user} 在请求中引用。
六、常见问题
- 模板删了,引用它的接口还能跑吗:能。历史引用仍可正常生成(生成器对逻辑删除的模板做了兼容),但建议尽快替换引用
- 批量生成能超过 1000 条吗:不能,前后端统一限制单次 1000 条,需要更多请分批生成
- 字段规则能复制到别的模板吗:可以,用字段规则区的「导出 / 导入」JSON 功能
