API 接口模拟

前端开发时后端接口还没好,可以先在这里定义 Mock 接口:方法、路径(支持 /users/:id 这样的路径参数)、状态码、延迟和 JSON 响应,响应中可以用变量生成随机值。输入请求地址就能试调匹配结果,再一键生成 MSW、Express、fetch 拦截代码或 OpenAPI 文档放进项目里。接口定义保存在本机浏览器中。

ms

变量:{{uuid}} {{id}} 自增编号、{{int:1-100}} {{float:0-1}} {{bool}} {{pick:待付款|已付款}} {{cname}} 中文姓名 {{email}} {{phone}} {{now}} 当前时间 {{date}} {{timestamp}},{{params.id}} 路径参数,{{query.page}} 查询参数。整个值只有一个数字类变量时会输出数字,如 "{{int:1-9}}" → 5。

试调

生成的代码怎么用

  • MSW(Mock Service Worker):在浏览器的 Service Worker 层拦截请求,业务代码完全不用改,开发和测试都能用。安装 npm i -D msw,执行 npx msw init public,把生成的 handlers 交给 setupWorker(...handlers).start()。
  • Express:起一个真实的本地 Mock 服务器,适合多人或移动端联调:npm i express 后 node mock-server.js,再把前端的接口地址指向它(注意跨域,代码已加 CORS 头)。
  • fetch 拦截:最轻量的方式,把代码放在应用入口最前面(仅开发环境),匹配到的请求直接返回 Mock 数据,其他请求照常发出。只拦截 fetch,不拦截 XMLHttpRequest。
  • OpenAPI:导出 OpenAPI 3.0 文档,可以导入 Postman、Apifox、Swagger UI,作为前后端约定的接口文档。

接口定义只保存在当前浏览器中,换设备请用“导出接口定义”。需要成批的测试数据可以用 Mock 数据生成器。

API 接口模拟常见问题

API 接口模拟怎么使用?

填写方法、路径、状态码、延迟、说明和响应 JSON 后点“保存接口”,左侧列表点选可编辑;在“试调”中输入方法和请求地址查看匹配的响应;右侧切换 MSW、Express、fetch 拦截、OpenAPI 复制代码,可导出、导入接口定义。

后端接口没好前端怎么联调?

先定义 Mock 接口和示例响应,用 MSW 或 fetch 拦截在前端返回模拟数据,后端好了直接切换。

MSW 是什么?

Mock Service Worker,在浏览器 Service Worker 层拦截请求,业务代码不用改就能返回模拟数据。

路径参数怎么写?

像 /api/users/:id 这样用冒号,响应里用 {{params.id}} 取值。

能导出给 Postman 吗?

可以导出 OpenAPI 3.0 文档,Postman、Apifox 都能导入。

API 接口模拟的结果应怎样理解?

导出的代码使用渲染一次后的示例数据;试调不会真的发出网络请求;接口定义保存在当前浏览器的本地存储中。

输入内容会保存或发给外部服务吗?

接口定义只保存在本机浏览器中,不会上传。

没有结果或操作失败时先检查什么?

试调返回 404 时检查方法是否一致、路径参数是否写成 :id;保存时报 JSON 错误,确认变量写在双引号里,如 "{{int:1-100}}"。

相关工具

OpenAPI / Swagger 文档查看器 · JSON Schema 生成器 · JSON 格式化校验 · Base64 编码解码 · 全部开发工具