wiremock/wiremock Docker 镜像 - 轩辕镜像

WireMock Docker镜像

![Main]([] ![Nightly]([] ![Docker Pulls]([] ![a]([]

---

---

WireMock独立部署的官方Docker镜像。它底层包含Java版WireMock，完全兼容其所有功能。您可以在WireMock文档网站了解更多关于WireMock独立版的信息。

快速开始

在临时目录中，克隆演示仓库，拉取Docker镜像，然后启动WireMock实例。

shell
docker pull wiremock/wiremock:latest
git clone [***]
docker run -it --rm \
  -p 8080:8080 \
  -v $PWD/wiremock-docker/samples/hello/stubs:/home/wiremock \
  wiremock/wiremock:latest

您将看到类似以下的CLI输出：

shell
██     ██ ██ ██████  ███████ ███    ███  ██████   ██████ ██   ██
██     ██ ██ ██   ██ ██      ████  ████ ██    ██ ██      ██  ██
██  █  ██ ██ ██████  █████   ██ ████ ██ ██    ██ ██      █████
██ ███ ██ ██ ██   ██ ██      ██  ██  ██ ██    ██ ██      ██  ██
 ███ ███  ██ ██   ██ ███████ ██      ██  ██████   ██████ ██   ██

----------------------------------------------------------------
|               Cloud: [***]               |
|               Slack: [***]              |
----------------------------------------------------------------

port:                         8080
enable-browser-proxying:      false
no-request-journal:           false
verbose:                      false
extensions:                   response-template,webhook

支持的架构

• x64
• armv7
• armv8

支持的标签

为最终用户提供了多个镜像标签。这些标签可在DockerHub和GitHub Packages上获取，完整列表见此处。以下列出最重要的标签：

最新镜像

• 3.13.1-1 (3.13.1-1/Dockerfile)
• 3.13.1-1-alpine (3.13-alpine/Dockerfile)
• latest (latest/Dockerfile)
• latest-alpine (latest-alpine/Dockerfile)
• main (main/Dockerfile)
• main-alpine (main-alpine/Dockerfile)

最新WireMock 2.x镜像

• 2.35.1-1 (2.35.1-1/Dockerfile)
• 2.35.1-1-alpine (2.35.1-1-alpine/Dockerfile)

已弃用和实验性标签

• nightly (main/Dockerfile-nightly)
• nightly-alpine (main-alpine/Dockerfile-nightly)
• 3x- 最新WireMock 3.x镜像，捆绑Java 11 - 现已更名为latest
• 3x-alpine - 最新WireMock Alpine 3.x镜像，捆绑Java 11 - 现已更名为latest

在Docker中使用WireMock

使用默认设置启动WireMock：

sh
docker run -it --rm -p 8080:8080 wiremock/wiremock

默认情况下，镜像暴露8080端口用于HTTP。要验证WireMock状态，访问http://localhost:8080/__admin/health可查看健康状态和信息。/__admin/health端点在WireMock 3.1.0及以上版本可用。

镜像中还内置了HEALTHCHECK，允许直接查询Docker容器的健康状态。其底层使用上述相同方法验证容器状态。

配置WireMock

您可以通过以下方式配置WireMock：

• 传递CLI参数
• 传递环境变量
• 通过卷挂载配置文件
• 使用wiremock/wiremock作为基础镜像构建自定义镜像

传递CLI参数

要使用WireMock参数启动，可将它们添加到命令行末尾。例如，启用HTTPS：--https-port 8443 --verbose

sh
docker run -it --rm -p 8443:8443 wiremock/wiremock --https-port 8443 --verbose

使用环境变量

镜像支持以下环境变量：

• uid：容器执行用户ID，用于避免创建root拥有的文件
• JAVA_OPTS：传递自定义Java选项，例如-Xmx128m
• WIREMOCK_OPTIONS：传递给WireMock的CLI选项（从3.2.0-2版本开始支持）

传递CLI选项的示例：

sh
docker run -it --rm \
  -e WIREMOCK_OPTIONS='--https-port 8443 --verbose' \
  -p 8443:8443 \
  --name wiremock \
  wiremock/wiremock:latest

通过卷挂载配置文件

容器内，WireMock使用/home/wiremock作为根目录，从中读取mappings和__files目录。这意味着您可以将包含这些目录的主机目录挂载到Docker中，WireMock将加载存根映射。

要挂载当前目录，使用-v $PWD:/home/wiremock，例如：

sh
docker run -it --rm \
  -p 8080:8080 \
  --name wiremock \
  -v $PWD:/home/wiremock \
  wiremock/wiremock:{{ site.wiremock_version }}

构建自定义镜像

容器内，WireMock使用/home/wiremock作为根目录，从中读取mappings和__files目录。这意味着您可以将主机配置复制到Docker中，WireMock将加载存根映射。

WireMock使用自定义入口点脚本，该脚本将所有提供的参数作为WireMock启动参数传递。要修改WireMock启动参数，建议在自定义Docker镜像中覆盖入口点。

Dockerfile
# 示例Dockerfile
FROM wiremock/wiremock:latest
COPY wiremock /home/wiremock
ENTRYPOINT ["/docker-entrypoint.sh", "--global-response-templating", "--disable-gzip", "--verbose"]

使用WireMock扩展

您可以将任何WireMock扩展与Docker镜像一起使用。它们可以通过CLI和卷添加，但对于大多数用例，建议通过扩展官方镜像构建自定义镜像。

在CLI中使用扩展

对于旧式扩展（没有Java服务加载器元数据），需要将扩展JAR文件添加到扩展目录，并通过--extensions参数指定扩展主类名：

sh
# 准备扩展文件夹
mkdir wiremock-docker/samples/random/extensions
# 下载扩展
wget [***] \
  -O wiremock-docker/samples/random/extensions/wiremock-body-transformer-1.1.3.jar
# 运行使用扩展的容器
docker run -it --rm \
  -p 8080:8080 \
  -v $PWD/wiremock-docker/samples/random/stubs:/home/wiremock \
  -v $PWD/wiremock-docker/samples/random/extensions:/var/wiremock/extensions \
  wiremock/wiremock \
    --extensions com.opentable.extension.BodyTransformer

对于新式扩展，不需要包含--extensions部分，因为扩展将被自动发现和加载：

sh
# 准备扩展文件夹
mkdir wiremock-docker/samples/random/extensions
# 下载扩展
wget [***] \
  -O wiremock-docker/samples/random/extensions/wiremock-grpc-extension-standalone-0.5.0.jar
# 运行使用扩展的容器
docker run -it --rm \
  -p 8080:8080 \
  -v $PWD/wiremock-docker/samples/random/stubs:/home/wiremock \
  -v $PWD/wiremock-docker/samples/random/extensions:/var/wiremock/extensions \
  wiremock/wiremock

在Dockerfile中使用扩展

sh
git clone [***]
docker build -t wiremock-random wiremock-docker/samples/random
docker run -it --rm -p 8080:8080 wiremock-random

访问http://localhost:8080/random查看随机数

高级用例

使用HTTPS

对于HTTPS，默认暴露8443端口。要使用HTTPS运行，执行以下命令：

sh
docker run -it --rm -p 8443:8443 wiremock/wiremock --https-port 8443 --verbose

要在默认暴露的端口上检查HTTPS，使用https://localhost:8443/__admin验证HTTPS是否正常工作。

使用记录模式

在记录模式下，当绑定主机文件夹（如$PWD/test）与容器卷（/home/wiremock）时，创建的文件将由root拥有，这在大多数情况下是不希望的。要避免此问题，可使用uid环境变量将主机uid与容器执行uid绑定。

sh
docker run -d --name wiremock-container \
  -p 8080:8080 \
  -v $PWD/test:/home/wiremock \
  -e uid=$(id -u) \
  wiremock/wiremock \
    --proxy-all="[***]" \
    --record-mappings --verbose
curl http://localhost:8080
docker rm -f wiremock-container

使用ls -alR test检查创建的文件所有者

不过，上述示例是一种便捷方法。最佳实践是手动创建具有正确权限的绑定文件夹，并使用-u Docker参数。

sh
mkdir test
docker run -d --name wiremock-container \
  -p 8080:8080 \
  -v $PWD/test:/home/wiremock \
  -u $(id -u):$(id -g) \
  wiremock/wiremock \
    --proxy-all="[***]" \
    --record-mappings --verbose
curl http://localhost:8080
docker rm -f wiremock-container

使用ls -alR test检查创建的文件所有者

Docker Compose

compose文件中的配置类似于Dockerfile定义

yaml
# 示例compose文件
version: "3"
services:
  wiremock:
    image: "wiremock/wiremock:latest"
    container_name: my_wiremock
    entrypoint: ["/docker-entrypoint.sh", "--global-response-templating", "--disable-gzip", "--verbose"]

您也可以将本地__files和mappings文件挂载到容器中，例如：

yaml
# 示例compose文件
version: "3"
services:
  wiremock:
    image: "wiremock/wiremock:latest"
    container_name: my_wiremock
    volumes:
      - ./__files:/home/wiremock/__files
      - ./mappings:/home/wiremock/mappings
    entrypoint: ["/docker-entrypoint.sh", "--global-response-templating", "--disable-gzip", "--verbose"]

参考资料

• Testcontainers的WireMock模块，基于此官方镜像
• WireMock的Helm Chart