跳到正文

创建 Mock REST API

自定义方法、路径、状态码、延迟和响应内容,或使用自动生成的假数据,创建假的 JSON 接口。接口由我们的服务器提供并支持 CORS,适合原型开发和测试。

用 :name 表示参数,例如 /users/:id

响应体
延迟0 ms

类似 "{{fullName}}" 或 "{{int(1, 100)}}" 的字符串会在每次请求时被替换。

项

填 0 则返回单个对象

占位符(36)
{{id}}
1、2、3……列表中的位置
{{index}}
0、1、2……从 0 开始的位置
{{uuid}}
随机 UUID v4
{{firstName}}
名
{{lastName}}
姓
{{fullName}}
姓名
{{username}}
小写用户名
{{email}}
example.com 邮箱地址
{{phone}}
电话号码(+1 555…)
{{company}}
公司名称
{{jobTitle}}
职位
{{street}}
街道地址
{{city}}
城市
{{country}}
国家
{{countryCode}}
ISO 3166 代码
{{zip}}
5 位邮政编码
{{domain}}
示例域名
{{url}}
https 网址
{{ipv4}}
文档保留段 IPv4 地址
{{color}}
HEX 颜色
{{word}}
一个 lorem 单词
{{words}}
words(n):n 个 lorem 单词
{{sentence}}
lorem 句子
{{paragraph}}
三到五个句子
{{int}}
int(min, max):整数
{{float}}
float(min, max, decimals)
{{price}}
price(min, max):两位小数
{{bool}}
true 或 false
{{date}}
过去一年内的日期(YYYY-MM-DD)
{{datetime}}
过去一年内的 ISO 日期时间
{{futureDate}}
未来一年内的日期
{{status}}
active、pending 或 inactive
{{pick}}
pick(a, b, c):任选其一
{{param}}
param(name):URL 路径中的值,例如 :id
{{query}}
query(name):查询字符串中的值
{{null}}
JSON null
响应头(可选,仅限 X- 开头)
3 / 10 个端点 · 返回 JSON,已启用 CORS
在我们的服务器上处理 · 接口的 JSON 会保留,直到你删除它,或 7 天内没有任何请求工作原理

Mock REST API 使用方法

  1. 1

    描述每个接口

    选择请求方法,输入路径(如 /users/:id),再设置状态码和可选的延迟,用来模拟较慢的网络。

  2. 2

    编写响应内容

    粘贴固定的 JSON,或切换到“假数据”,用 {{fullName}} 这样的占位符编写模板,并设置列表数量。

  3. 3

    创建模拟 API

    点击“创建模拟 API”获取基础 URL;每个接口都在该 URL 加上其路径的地址响应,并已启用 CORS。

  4. 4

    调用并反复调整

    在应用中使用“试用”、curl 或 fetch 调用,然后修改并保存,更改会立即生效;用完后可删除该模拟 API。

限制与 Pro

免费:每个模拟 API 最多 10 个接口,单个内容 100 KB,总计 512 KB,延迟最长 5 秒,生成的列表最多 100 项,每位访客每分钟 120 次请求,每小时可新建 10 个模拟 API,连续 7 天无请求后删除。

Pro 将限制提高到 50 个接口、1 MB 的内容、30 秒的延迟和 1,000 项的列表。 了解 Pro

关于 Mock REST API

Mock REST API 让前端和移动端开发者在真实后端完成之前,就能用上可正常工作的接口。每个模拟 API 都有各自的基础 URL,位于 /api/mock-api/m/ 之下,你定义的每个接口都会在这里按所选的请求方法、路径、状态码、延迟、请求头和 JSON 内容作出响应。路径可以包含参数,例如 /users/:id 可以匹配 /users/7,模板中还能用 {{param(id)}} 回显这个值,或用 {{query(name)}} 读取查询字符串。

假数据模式会用 36 种占位符把 JSON 模板变成逼真的响应,涵盖姓名、邮箱、公司、城市,以及 UUID、日期、价格、指定范围内的数字和 lorem 文本。设置列表数量后,可返回最多 100 项的数组,还能选择多次请求之间数据保持不变(适合快照测试)或每次都变化。200 到 599 的状态码可用来演练 401、404、429、503 等错误状态,最长五秒的延迟可以检验加载状态的表现。

响应始终是带 CORS 头的 JSON,任何来源的浏览器都能调用。模拟 API 不能返回 HTML、设置 Cookie 或重定向,也不会保存收到的请求,更不是数据库:POST 和 PUT 只会返回你配置好的内容,不会保存发送给它们的任何数据。

隐私

为了托管你的接口,你保存的定义(请求方法、路径、状态码、延迟、请求头和内容)会发送并存储在我们的服务器上,同时保存的还有经过哈希处理的编辑令牌、创建时间和最近一次请求的时间,以及请求次数。对接口的请求会被正常响应,但不会记录其内容、请求头或 IP 地址。模拟 API 会在你删除时,或连续 7 天没有请求和编辑后被删除,编辑令牌只保存在当前浏览器中。任何拿到 URL 的人都能调用你的接口,请不要在其中放入机密信息或真实的个人数据。

功能

真实的 HTTPS 接口

支持任意请求方法、路径参数、200 到 599 的状态码、延迟和自定义 X- 请求头。

假数据模板

30 多种占位符,涵盖人物、公司、地点、日期、数字和文本,可生成单个对象或列表。

安全设计

仅限 JSON,已启用 CORS,不记录请求,编辑令牌经哈希处理,7 天未使用即删除。

Mock REST API:常见问题

服务器上会存储什么,保存多久?
我们会存储你保存的接口定义、编辑令牌的 SHA-256 哈希、模拟 API 的创建时间和最近调用时间,以及收到的请求次数。我们不会记录请求内容、请求头或 IP 地址。模拟 API 会在你点击“删除”时被删除,或在连续 7 天没有任何请求和编辑后自动删除,所以持续使用的 API 会一直可用。
能在我的前端应用中调用模拟 API 吗?
可以。每个响应都带有设为 * 的 Access-Control-Allow-Origin,预检 OPTIONS 请求也会得到响应,因此任何域名(包括 localhost)上的 fetch、axios 或其他浏览器 HTTP 客户端都能调用。使用基础 URL 加接口路径即可,例如 fetch(base + "/users")。接口就是普通的 HTTPS 地址,所以移动应用、Postman 和 curl 也都能用。
假数据占位符是怎么工作的?
在假数据模式下,JSON 模板里作为占位符的字符串,如 "{{email}}" 或 "{{int(1, 100)}}",会在请求到达时被替换;整个字符串都是数字或 true、false 的占位符,会变成真正的 JSON 数字和布尔值。占位符也可以放在文本中,如 "Hello {{firstName}}"。设置列表数量即可重复模板,其中 {{id}} 会为每一项依次计数 1、2、3。
模拟接口能返回错误或慢响应吗?
可以。你可以选择 200 到 599 之间的任意状态码,如 401 Unauthorized、404 Not Found、用于校验错误的 422、429 Too Many Requests 或 503,并写出应用所需的错误 JSON。免费版的延迟滑块最多可让每个响应等待 5 秒,有助于测试加载动画、超时和重试逻辑。状态码 204 和 304 的响应不会带内容。
为什么模拟 API 不能返回 HTML 或设置 Cookie?
能返回任意内容的免费托管接口,很容易被用来制作钓鱼页面和恶意软件链接。为了让这些模拟接口只能当作 API 使用,每个响应都是带 nosniff 和严格内容安全策略的 application/json,且只允许以 X- 开头的自定义请求头,因此无法设置 Cookie、重定向浏览器或冒充网页。