10 款常用的 API Mock 服务器工具

市面上常见的十款工具 API Mock 零基础教程

你是否曾因为后端接口还没开发完成而苦恼，而你作为前端开发人员却迫不及待地想要开始写代码？API Mock 服务器就是你的救星！它们可以快速搭建一个虚拟的后端环境，使你可以立即开始测试和开发。这篇文章将介绍 10 款 API Mock 服务器工具，并以轻松幽默的语气向你展示如何快速上手使用它们。

1. Nock

介绍

Nock 是一个基于 Node.js 的 HTTP 服务器模拟桩库，它可以拦截和记录 HTTP 请求，并根据预设规则返回模拟的响应。它允许你使用 JavaScript 代码编写自定义逻辑。

应用场景

适合在 Node.js 环境中进行单元测试和集成测试，模拟复杂的 API 请求和响应。

快速上手

1. 使用 npm 或 yarn 安装 nock：

npm install nock  

1. 创建一个简单的 nock 拦截示例：

const nock = require('nock');  nock('http://api.example.com')    .get('/users')  .reply(200, [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]);```### 常用特性  - 支持拦截各种 HTTP 方法（GET、POST、PUT 等）  - 可以设置请求头、查询参数等匹配条件  - 支持动态生成响应内容    ### 注意事项  - 使用 Nock 时，需要确保你的代码能够处理异步操作  - 请确保每次测试后清除所有拦截器，以避免测试用例之间的干扰    ### 原理概述  Nock 通过拦截 Node.js 的底层 HTTP 请求函数，将实际请求替换为模拟请求。这样，当你的代码向外部 API 发送请求时，Nock 会捕获该请求并返回预定义的响应。  ## 2. WireMock  ### 介绍  WireMock 是一个 HTTP Mock 服务器，可以作为一个独立的进程运行，或者嵌入到 Java 应用程序中。它支持用 JSON 或 XML 文件定义模拟请求和响应，提供了一个简单的 web 界面用于配置。  ### 应用场景  适合 Java 项目中进行 API 模拟，以及需要独立运行的 HTTP Mock 服务器。  ### 快速上手  1. 下载 WireMock 的 standalone JAR 文件：  ```bash  curl -o wiremock-standalone.jar http://repo1.maven.org/maven2/com/github/tomakehurst/wiremock-standalone/2.31.0/wiremock-standalone-2.31.0.jar  

2. 运行 WireMock：

java -jar wiremock-standalone.jar````1. 创建一个 JSON 文件，例如 `mock-api.json`，并编写模拟规则：  ```json  {    "request": {    "method": "GET",    "url": "/users"  },  "response": {    "status": 200,    "body": "[{\"id\": 1, \"name\": \"Alice\"}, {\"id\": 2, \"name\": \"Bob\"}]",    "headers": {      "Content-Type": "application/json"    }  }}  

1. 将 JSON 文件添加到 WireMock 的映射目录：

cp mock-api.json mappings/  

常用特性

• 支持多种请求匹配方式，如 URL、请求头、正文等

• 支持动态生成响应内容，如随机数、日期等

• 支持录制和回放 API 请求

  注意事项

• 使用 WireMock 时，需要确保你的应用正确处理 HTTP 通信异常

• 将模拟规则保存在版本控制系统中，以便团队成员协同工作

  原理概述

WireMock 通过拦截 HTTP 请求，并根据预定义的模拟规则返回响应。它既可以作为一个独立的服务器运行，也可以嵌入到 Java 应用程序中。这使得 WireMock 成为 Java 项目的理想选择。

3. Postman

介绍

Postman 是一款广受欢迎的 API 开发和测试工具。除了支持 API 请求测试和文档生成外，它还允许你设置模拟服务器（Mock Servers）来模拟 API 响应。Postman 提供了直观的可视化界面，并支持使用 JavaScript 编写预请求脚本和测试脚本。

应用场景

适合在 API 开发和测试阶段快速创建和维护模拟服务器，以及进行 API 文档生成。

快速上手

1. 安装并启动 Postman。
2. 创建一个新的 Collection。
3. 点击 Collection 旁边的三个点，然后选择 “Create a mock server”。
4. 按照向导创建一个 Mock 服务器，定义请求和响应规则。

常用特性

• 支持创建和管理多个模拟服务器

• 支持对请求和响应进行脚本化处理

• 集成 API 文档生成和测试功能

  注意事项

• 使用 Postman 时，确保 Postman 应用程序保持在线

• 将 Collection 与团队成员共享，以便进行协同开发

  原理概述

Postman 模拟服务器通过在云端搭建一个虚拟的 API 服务器来实现 API 模拟。你可以通过创建 Collection 定义请求和响应规则，然
后将它们部署到模拟服务器上。这样，你的应用程序可以向模拟服务器发送请求，而不是实际的 API 服务器。

4. json-server

介绍

json-server 是一个基于 Node.js 的简单命令行工具，可以根据 JSON 文件快速创建 RESTful API 模拟服务。虽然它的可视化界面相对简单，但可以轻松地使用 JavaScript 语法定义和修改数据。

应用场景

适合在前端开发过程中快速创建和修改 RESTful API 模拟服务器。

快速上手

1. 使用 npm 或 yarn 安装 json-server：

npm install -g json-server  

1. 创建一个 JSON 文件，例如 db.json，并编写模拟数据：

{    "users": [    { "id": 1, "name": "Alice" },    { "id": 2, "name": "Bob" }  ]}  

1. 启动 json-server：

json-server --watch db.json  

常用特性

• 支持快速生成 RESTful API

• 支持自定义路由和中间件

• 支持使用 JavaScript 语法处理数据

  注意事项

• json-server 仅适用于简单的 API 模拟，不适合复杂的业务逻辑

• 在使用 json-server 时，确保 JSON 文件的数据结构符合 RESTful API 的规范

  原理概述

json-server 通过读取 JSON 文件并将其转换为 RESTful API，使前端开发者能够轻松地创建和修改模拟服务器。json-server 使用 Node.js 运行，并支持自定义中间件和路由。

5. Nuxt.js

介绍

Nuxt.js 是一个基于 Vue.js 的 Web 应用框架，提供了一个内置的服务器中间件功能。你可以使用 Nuxt.js 的服务器中间件功能轻松创建 API Mock 服务，并使用 JavaScript 语法自定义数据。

应用场景

适合使用 Vue.js 和 Nuxt.js 开发的项目，需要在开发环境中模拟 API 服务器。

快速上手

1. 使用 create-nuxt-app 创建一个新的 Nuxt.js 项目：

npx create-nuxt-app my-nuxt-app  

1. 在 serverMiddleware 配置中添加一个新的中间件：

// nuxt.config.js  export default {    serverMiddleware: [    '~/api/index.js'  ]}  

1. 创建一个 api 目录，然后编写中间件代码：

// api/index.js  const express = require('express');  const app = express();  app.get('/users', (req, res) => {    res.json([    { id: 1, name: 'Alice' },    { id: 2, name: 'Bob' }  ]);});  module.exports = app;  

常用特性

• 支持创建和管理多个模拟服务器

• 完全集成到 Nuxt.js 项目中，方便前端开发

• 支持使用 Express.js 或其他 Node.js 中间件框架

  注意事项

• Nuxt.js 仅适用于 Vue.js 项目，不适合其他框架

• 确保在部署生产环境时禁用模拟 API 服务器

  原理概述

Nuxt.js 的服务器中间件允许你在项目中添加自定义的 API 服务器。这使得前端开发者可以在开发环境中轻松地创建和修改模拟 API 服务器。服务器中间件使用 Node.js 运行，支持使用 Express.js 或其他 Node.js 中间件框架。

6. Mirage JS

介绍

Mirage JS 是一个用于前端开发的 API Mock 工具。它可以拦截和模拟 AJAX 请求，使前端开发者能够在不依赖后端服务器的情况下进行开发。Mirage JS 支持 JavaScript 语法，允许你轻松地定义和修改模拟数据。

应用场景

适用于前端开发过程中需要模拟 AJAX 请求的场景。

快速上手

1. 使用 npm 或 yarn 安装 Mirage JS：

npm install miragejs  

1. 在项目中创建一个 Mirage JS 服务器：

import { createServer } from 'miragejs';  createServer({    routes() {    this.get('/api/users', () => [      { id: 1, name: 'Alice' },      { id: 2, name: 'Bob' }    ]);  }});  

常用特性

• 支持拦截和模拟各种 AJAX 请求

• 支持使用 JavaScript 语法定义和修改模拟数据

• 支持模拟关联数据和数据库操作

  注意事项

• 在生产环境中禁用 Mirage JS，以避免影响实际的 API 请求

• 请确保每次测试后清除所有拦截器，以避免测试用例之间的干扰

  原理概述

Mirage JS 通过拦截浏览器的 AJAX 请求，并根据预设规则返回模拟响应。这使得前端开发者可以在不依赖后端服务器的情况下进行开发。

7. Beeceptor

介绍

Beeceptor 是一款在线的 API Mock 工具，允许你轻松地创建和管理模拟服务器。它提供了一个直观的可视化界面，并支持使用 JSON 定义请求和响应规则。

应用场景

适用于需要快速创建和共享在线模拟服务器的场景。

快速上手

1. 访问 Beeceptor 网站：https://beeceptor.com/
2. 创建一个新的 Mock 服务器，并设置自定义子域
3. 在 Beeceptor 的 Dashboard 中，添加新的模拟规则，例如：

规则名称：Get Users  请求方法：GET  请求路径：/users  响应状态：200  响应正文：[    { "id": 1, "name": "Alice" },  { "id": 2, "name": "Bob" }]  

1. 使用你的应用程序向模拟服务器发送请求，例如：https://your-subdomain.beeceptor.com/users

常用特性

• 支持在线创建和管理模拟服务器

• 支持请求匹配和动态响应生成

• 提供实时请求和响应日志

  注意事项

• Beeceptor 提供免费和付费版本，根据使用需求选择合适的版本

• 在生产环境中禁用 Beeceptor，以避免影响实际的 API 请求

  原理概述

Beeceptor 通过在线创建虚拟 API 服务器，并根据预设规则拦截和模拟请求。这使得前端开发者可以在不依赖后端服务器的情况下进行开发，并方便地与团队成员共享模拟服务器。

8. Apiary

介绍

Apiary 是一个 API 设计和文档工具，支持创建和管理模拟服务器。它使用 API Blueprint 或 Swagger/OpenAPI 规范来定义 API，并提供一个直观的可视化界面。

应用场景

适用于需要同时进行 API 设计、文档生成和模拟服务器管理的场景。

快速上手

1. 访问 Apiary 网站：https://apiary.io/
2. 注册并登录 Apiary。
3. 创建一个新的 API 项目，并编写 API Blueprint 或 Swagger/OpenAPI 规范。
4. 在 Apiary 的 Dashboard 中，启用 Mock 服务器功能。

常用特性

• 支持 API Blueprint 和 Swagger/OpenAPI 规范

• 支持在线创建和管理模拟服务器

• 集成 API 设计和文档生成功能

  注意事项

• Apiary 提供免费和付费版本，根据使用需求选择合适的版本

• 在生产环境中禁用 Apiary，以避免影响实际的 API 请求

  原理概述

Apiary 通过解析 API 规范文件，并在云端创建虚拟 API 服务器。这使得前端开发者可以在不依赖后端服务器的情况下进行开发，并方便地与团队成员共享模拟服务器和 API 文档。

9. Stoplight

介绍

Stoplight 是一个 API 设计、测试和文档平台，支持创建和管理模拟服务器。它使用 OpenAPI 规范来定义 API，并提供一个直观的可视化界面。

应用场景

适用于需要同时进行 API 设计、测试、文档生成和模拟服务器管理的场景。

快速上手

1. 访问 Stoplight 网站：https://stoplight.io/
2. 注册并登录 Stoplight。
3. 创建一个新的 API 项目，并编写 OpenAPI 规范。
4. 在 Stoplight 的 Dashboard 中，启用 Mock 服务器功能。

常用特性

• 支持 OpenAPI 规范

• 支持在线创建和管理模拟服务器

• 集成 API 设计、测试和文档生成功能

  注意事项

• Stoplight 提供免费和付费版本，根据使用需求选择合适的版本

• 在生产环境中禁用 Stoplight，以避免影响实际的 API 请求

  原理概述

Stoplight 通过解析 API 规范文件，并在云端创建虚拟 API 服务器。这使得前端开发者可以在不依赖后端服务器的情况下进行开发，并方便地与团队成员共享模拟服务器和 API 文档。

10. WireMock

介绍

WireMock 是一个 HTTP 模拟服务器，可以作为一个独立的进程运行，也可以嵌入到 Java 应用程序中。它支持创建和管理模拟服务器，并提供了灵活的请求匹配和响应生成功能。

应用场景

适用于需要在本地或远程服务器上运行模拟服务器的场景，尤其是 Java 项目。

快速上手

1. 下载 WireMock 的可执行 JAR 文件：http://wiremock.org/docs/running-standalone/
2. 使用命令行启动 WireMock：

java -jar wiremock-standalone-2.27.2.jar  

1. 创建 JSON 文件来定义请求匹配和响应生成规则：

{    "request": {    "method": "GET",    "url": "/users"  },  "response": {    "status": 200,    "body": "[{\"id\": 1, \"name\": \"Alice\"}, {\"id\": 2, \"name\": \"Bob\"}]"  }}  

1. 将 JSON 文件放置在 WireMock 的 mappings 目录下。

常用特性

• 支持作为独立进程或嵌入到 Java 应用程序中运行

• 支持灵活的请求匹配和响应生成功能

• 支持扩展和集成其他工具

  注意事项

• 在生产环境中禁用 WireMock，以避免影响实际的 API 请求

• 如果将 WireMock 嵌入到 Java 应用程序中，确保正确处理生命周期和资源管理

  原理概述

WireMock 是一个基于 Java 的 HTTP 模拟服务器，它可以拦截和模拟 HTTP 请求，并根据预设规则返回模拟响应。这使得前端开发者可以在不依赖后端服务器的情况下进行开发，并方便地与团队成员共享模拟服务器。

总结

在本文中，我们介绍了 10 款常用的 API Mock 服务器工具，分别为：

1. Postman
2. Nock
3. json-server
4. Mockoon
5. Nuxt.js 模拟 API 服务器
6. Mirage JS
7. Beeceptor
8. Apiary
9. Stoplight
10. WireMock

每款工具都有其特点和适用场景。当你需要模拟 API 服务器时，可以根据项目需求和团队协作情况选择合适的工具。同时，了解工具的快速上手方法、常用特性、注意事项和原理概述，可以帮助你更高效地使用这些工具。

最后，请注意在生产环境中禁用模拟 API 服务器，以避免影响实际的 API 请求。祝你在前端开发的道路上越走越远，掌握这些工具，让你的项目愈发完美！

来源地址：https://blog.csdn.net/HongZeng_CSDN/article/details/130337917