mocksserver/main

关于Mocks Server

Mocks Server是一个Node.js模拟服务器，可运行实时、交互式的模拟服务以替代真实API。它支持为同一路由定义多种不同响应，因此只需在服务器运行时更改一个或多个路由的响应，即可改变整个模拟API的行为。

核心功能与特性

• 多格式路由定义：支持通过YAML、JSON、JavaScript或TypeScript文件定义模拟API路由，自动加载并监听文件变化
• 灵活的路由类型：路由可通过多种方式定义，从简单对象、纯文本到Express中间件
• 多样化响应行为：支持直接发送响应或代理请求到其他主机
• 丰富的集成工具：可通过REST API、JavaScript、Cypress命令、交互式CLI等方式动态更改模拟响应

使用场景与适用范围

适用于前端开发、API测试、前后端并行开发等场景，尤其适合需要模拟API但不想依赖真实后端服务的开发流程。

使用方法

Docker基础使用

Mocks Server Docker镜像（mocksserver/main）包含@mocks-server/main NPM包，可通过docker run命令启动：

sh
docker run -ti -p 3100:3100 -p 3110:3110 mocksserver/main

启动后，由于未提供"mocks"文件夹和配置文件，服务器会自动创建脚手架。可通过以下URL访问：

• http://localhost:3100/api/users - 脚手架中包含的示例路由响应
• http://localhost:3110 - 管理REST API的Swagger UI界面

提供路由、集合和配置文件

Docker镜像中的Mocks Server应用预配置为在/input文件夹中查找包含路由和集合的mocks文件夹以及配置文件。可按照项目文档中的文件组织指南，将本地文件结构挂载到容器的/input文件夹。

假设本地文件结构如下：

project/
├── mocks/
│   ├── routes/ <- 在此定义路由
│   │   ├── common.js
│   │   └── users.js
│   └── collections.json <- 在此定义集合
└── mocks.config.js <- 在此定义配置

可通过以下命令将本地project文件夹挂载为容器的/input文件夹：

sh
docker run -ti -p 3100:3100 -p 3110:3110 \
  -v /Users/foo/project:/input \
  mocksserver/main

此时Mocks Server将加载本地的路由、集合和配置文件并启动模拟服务器。

配置

根据更改设置文档，可通过环境变量修改Mocks Server配置。示例：

sh
docker run -ti -p 3100:3100 -p 3110:3110 \
  -v /Users/foo/project:/input \
  -e MOCKS_LOG=debug \
  mocksserver/main

Docker镜像包含以下预配置，可通过环境变量自定义：

• MOCKS_PLUGINS_INQUIRER_CLI_ENABLED=false：默认禁用交互式CLI
• MOCKS_FILES_PATH=/input/mocks：默认mocks路径为/input/mocks
• MOCKS_CONFIG_FILE_SEARCH_FROM=/input：默认在/input文件夹中查找配置文件

⚠️ 注意

容器中的应用运行在/usr/app文件夹，这是用于解析相对路径的process.cwd。建议在配置中使用绝对路径。

文档

查看项目完整文档