WireMock User Documentation

WireMock is a popular open-source tool for API mock testing, with over 5 million downloads per month. It can help you to create stable test and development environments, isolate yourself from flakey 3rd parties and simulate APIs that don't exist yet.

Getting Started#

Overview Quick Start Download Get Help

Distributions#

WireMock provides the following generic distributions that allow running it as a standalone server in a container or within a Java Virtual Machine.

Standalone JAR Docker Helm (Experimental) WireMock Cloud (commercial SaaS) NPM

By use-case#

Below you can find links to the documentation for WireMock key use-cases. You can find more documentation pages on the sidebar.

Advanced request matching Dynamic response templating Use API Mocking in your unit tests Fault and latency injection Record / Playback Use pre-defined Mock API templates Extending WireMock

By protocol#

WireMock can serve all HTTP-based protocols and REST API. Through built-in features and extensions, it provides additional capabilities for widely used protocols.

Webhooks and Callbacks HTTPs gRPC GraphQL

By technology#

There are also solutions and guides for particular technologies and frameworks, provided by the WireMock community and external contributors.

Java and JVM Python Spring Boot Node.js Android .NET Golang Rust Groovy Kotlin Kubernetes Testcontainers Quarkus C/C++