开发
API

API Mock 使用文档

简介

API Mock 是一个能够为字节小程序开发者提供接口 Mock 功能的工具,开发者可以通过设置 Mock 配置信息拦截符合匹配规则的 API 调用,拦截成功的 API 将直接返回开发者所定义的返回数据。当本地的开发者工具不支持某些 API 或者服务端某些网络接口还未开发完成时,该工具能够协助开发者及时测试小程序的完整功能。

运行环境

下载并安装3.2.1或以上版本的开发者工具,下载地址

使用方法

启用功能

API Mock 工具的入口在调试器中的 Mock 面板,点击 + 可新建规则

数据管理

目前支持的 API 有tt.requesttt.downloadFilett.checkSessiontt.getLocation,当一个 API 配置了多个规则时,越靠前的规则,优先级越高,一旦某个规则匹配成功后,后面的规则将不再生效,可以通过拖拽调整规则匹配优先级。

匹配规则

参数匹配规则支持正则表达式语法,并且支持多层级匹配

若未配置匹配规则,默认返回模拟数据,若某条规则的参数名或正则内容为空,则该条规则将不会生效

例如:当tt.request 的参数 data 为对一个对象时,可以对该对象中 name 属性设置匹配规则

返回数据

模拟返回中可以选择数据返回的状态,选择后就会调用对应的回调函数。

目前返回数据的生成方式支持自定义、数据模板和动态生成三种方式。

1. 自定义

可直接输入 JSON 数据

{
  "data": {},
  "header": {},
  "statusCode": 200
}

2. 数据模板

数据模板支持 Mock.js 语法,语法参考

3. 动态生成

也支持直接编写 js 函数,动态返回数据,该函数的参数为调用该 API 时的参数对象,可以根据参数中的数据动态定制返回数据

点击纠错
该文档是否对你的开发有所帮助?
有帮助
没帮助
该文档是否对你的开发有所帮助?
有帮助
没帮助