Download and Installation

Download options #

WireMock Java is distributed in two flavours - a standard JAR containing just WireMock, and a standalone uber JAR containing WireMock plus all its dependencies.

Most of the standalone JAR’s dependencies are shaded i.e. they are hidden in alternative packages. This allows WireMock to be used in projects with conflicting versions of its dependencies. The standalone JAR is also runnable (see Running as a Standalone Process).

WireMock currently has two releases available. The 3.x release (below) and the new 4.x beta releases.

3.x Release Downloads #

Test dependencies #

Maven
Gradle
Kotlin
SBT
  • Maven
  • Gradle Groovy
  • Gradle Kotlin
  • Scala SBT

Add the following to your project's pom.xml dependencies:

<dependency>
  <groupId>org.wiremock</groupId>
  <artifactId>wiremock</artifactId>
  <version>3.13.0</version>
  <scope>test</scope>
</dependency>

Then follow the next steps for JUnit 5+ or plain Java.

Add the following to your project's build.gradle:

testImplementation "org.wiremock:wiremock:3.13.0"

Then follow the next steps for JUnit 5+ or plain Java.

Add the following to your project's build.gradle.kts:

testImplementation("org.wiremock:wiremock:3.13.0")

Then follow the next steps for JUnit 5+ or plain Java.

Add the following to your project’s build.sbt:

libraryDependencies +=
  "org.wiremock" % "wiremock" % "3.13.0" % Test

Download the latest standalone JAR then run the following in a terminal:

java -jar wiremock-standalone-3.13.0.jar

Learn more in the running standalone guide.

Run the following in a terminal:

docker run -it --rm \
  -p 8080:8080 \
  --name wiremock \
  wiremock/wiremock:3.13.0

Learn more in the Docker guide.

Standalone Service #

Run the following in a terminal:

docker run -it --rm -p 8080:8080 --name wiremock \
  wiremock/wiremock:3.13.0
<dependency>
    <groupId>org.wiremock</groupId>
    <artifactId>wiremock-standalone</artifactId>
    <version>3.13.0</version>
    <scope>test</scope>
</dependency>
testImplementation "org.wiremock:wiremock-standalone:3.13.0"

Learn more in the Docker guide.

Direct download #

If you want to run WireMock as a standalone process you can download the standalone JAR from here

4.x Beta Release Downloads #

The 4.x release of WireMock is currently in beta. These releases are under active development and we recommend you try it out. We would love to hear your feedback over on the community slack - https://slack.wiremock.org/

We have given these releases a beta label due to the fact that as we move forwards with the 4.x release there will be breaking changes. These are the current updates to the 4.x release:

  • Java 17 is now the baseline java version
  • Jetty 12 is shipped by default so there is no longer a specific jetty 12 release of 4.x and Jetty 11 is no longer supported

Test dependencies #

Maven
Gradle
Kotlin
SBT
  • Maven
  • Gradle Groovy
  • Gradle Kotlin
  • Scala SBT

Add the following to your project's pom.xml dependencies:

<dependency>
  <groupId>org.wiremock</groupId>
  <artifactId>wiremock</artifactId>
  <version>4.0.0-beta.2</version>
  <scope>test</scope>
</dependency>

Then follow the next steps for JUnit 5+ or plain Java.

Add the following to your project's build.gradle:

testImplementation "org.wiremock:wiremock:4.0.0-beta.2"

Then follow the next steps for JUnit 5+ or plain Java.

Add the following to your project's build.gradle.kts:

testImplementation("org.wiremock:wiremock:4.0.0-beta.2")

Then follow the next steps for JUnit 5+ or plain Java.

Add the following to your project’s build.sbt:

libraryDependencies +=
  "org.wiremock" % "wiremock" % "3.13.0" % Test

Download the latest standalone JAR then run the following in a terminal:

java -jar wiremock-standalone-4.0.0-beta.2.jar

Learn more in the running standalone guide.

Standalone Service #

Run the following in a terminal:

<dependency>
    <groupId>org.wiremock</groupId>
    <artifactId>wiremock-standalone</artifactId>
    <version>4.0.0-beta.2</version>
    <scope>test</scope>
</dependency>
testImplementation "org.wiremock:wiremock-standalone:4.0.0-beta.2"

Direct download #

If you want to run WireMock as a standalone process you can download the standalone JAR from here