holomekc/wiremock-gui

WireMock with GUI

基于WireMock扩展的Docker镜像，提供图形用户界面（GUI），简化API模拟和测试过程，适用于开发和测试环境中快速创建、管理和测试API模拟服务。

核心功能

映射（Mappings）

• 分页列表或文件夹视图展示所有映射
• 映射搜索功能
• 添加/编辑/删除映射
• 直接在映射中添加模板（响应模板、代理等）
• 保存/重置/删除所有映射
• 重置所有场景
• 分离视图提升可读性
• 测试映射：允许通过发送HTTP请求快速测试映射

文件（Files）

• 上传、下载文件
• 创建或编辑文件

已匹配请求（Matched）

• 分页列表展示所有被WireMock处理的请求
• 复制cUrl命令
• 重置请求日志

未匹配请求（Unmatched）

• 分页列表展示所有未被WireMock处理的请求
• 复制cUrl命令
• 复制请求内容到剪贴板用于创建新映射
• 复制SOAP内容到剪贴板（理解未匹配的SOAP请求，辅助创建映射）
• 重置请求日志

状态机（StateMachine，实验性）

• 分页列表展示属于场景的所有映射
• 自动计算状态
• 映射以链接形式展示
• 链接按钮可查看映射详情

存根录制与回放（Record/playback of stubs）

• 辅助启动录制或快照功能

自动刷新

• 当映射或请求变化时自动刷新界面

如何访问GUI？

GUI集成在WireMock管理界面中，通过以下URL访问：

<WireMock基础URL>/__admin/webapp

文件夹视图

自版本2.32.0.2起提供

映射默认使用文件夹视图，仍可切换至平面列表视图。若映射存储在不同目录中，界面会自动提取目录结构并更新映射元数据，以展示相同的文件夹结构。也可手动更新映射元数据创建结构（适用于通过HTTP加载映射或不想使用物理目录的场景）。

元数据结构示例：

json
{
  "metadata": {
    "wiremock-gui": {
      "folder": "/some/folder"
    }
  }
}

上述结构将在GUI中创建如下目录：
（原图片链接：展示文件夹结构界面）

编辑映射时，可通过"通用功能" -> "添加文件夹"添加文件夹元数据。

拖放功能

目前不支持拖放至文件夹。相关功能已在开发分支实现，测试时可能因排序未支持导致重载后位置变化。

测试映射

自版本2.32.0.2起提供

允许通过HTTP请求测试映射，功能会尝试从映射信息中提取URL和内容类型（依赖映射中请求的定义方式）。执行请求后显示响应，徽章指示所选映射是否响应请求：

• 匹配时：显示映射响应成功标识（原图片链接：测试匹配界面）
• 其他映射响应时：显示指向响应映射的链接（原图片链接：测试不匹配界面）

注：此功能不替代Postman、Insomnia等专业工具，旨在快速验证映射配置。

GUI外的功能

自定义Handlebars助手

Docker部署

重大变更 > 2.35.0.1

Docker镜像现已基于官方https://hub.docker.com/r/wiremock/wiremock镜像构建，配置等请参考官方指南。下文Docker Compose示例已更新。

Docker Compose示例

yaml
version: "3"
services:
  wiremock:
    image: "docker.xuanyuan.run/holomekc/wiremock-gui:latest"
    container_name: my_wiremock
    ports:
      # 端口映射示例
      - "8088:8089"  # HTTP端口
      - "8084:8088"  # HTTPS端口
    command:
      "--port 8089 --https-port 8088 --max-request-journal 1000 --local-response-templating"
    volumes:
      - ./root-dir:/home/wiremock  # 挂载本地目录到容器内WireMock工作目录
    environment:
      WIREMOCK_MY_VAR: "systemValue response templating feature"  # 响应模板使用的环境变量

Docker镜像信息

https://hub.docker.com/r/holomekc/wiremock-gui

历史仅提供Alpine镜像，新版标签规则：

• holomekc/wiremock-gui:{version} 或 holomekc/wiremock-gui:latest
  支持平台：linux/amd64、linux/arm/v7、linux/arm64

• holomekc/wiremock-gui:{version}-alpine 或 holomekc/wiremock-gui:latest-alpine
  支持平台：linux/amd64

Mac M[1-2]处理器注意事项

Apple Mac M1/M2处理器无法使用Alpine镜像。因官方WireMock Alpine镜像基于eclipse-temurin，暂不支持ARM架构（参考：https://github.com/adoptium/containers/issues/158），建议使用非Alpine版本。

界面截图参考

• https://raw.githubusercontent.com/holomekc/wiremock/refs/heads/master/images/mappings.png
• https://raw.githubusercontent.com/holomekc/wiremock/refs/heads/master/images/mappings-separated.png
• https://raw.githubusercontent.com/holomekc/wiremock/refs/heads/master/images/state-machine.png
• https://raw.githubusercontent.com/holomekc/wiremock/refs/heads/master/images/test.png
• https://raw.githubusercontent.com/holomekc/wiremock/refs/heads/master/images/test-response.png

安全说明

• 版本 < 3.0.4.0存在XSS问题，详情：https://github.com/holomekc/wiremock/issues/51