WireMock.Net

A C# .NET version based on mock4net which mimics functionality from the original Java based WireMock.

---

📚 Full documentation can now be found at wiremock.org

---

⭐ Key Features

• HTTP response stubbing, matchable on URL/Path, headers, cookies and body content patterns
• Library can be used in unit tests and integration tests
• Runs as a standalone process, as windows service, as Azure/IIS or as docker
• Configurable via a fluent C# .NET API, JSON files and JSON over HTTP
• Record/playback of stubs (proxying)
• Per-request conditional proxying
• Stateful behaviour simulation
• Response templating / transformation using Handlebars and extensions
• Can be used locally or in CI/CD scenarios
• Can be used for Aspire Distributed Application testing
• GraphQL support
• gRPC / ProtoBuf support
• OpenAPI support
• OpenTelemetry support
• WebSockets support

📝 Blogs

• mstack.nl : Generate C# Code from Mapping(s)
• mstack.nl : Chaos Engineering with Fault Injections
• mstack.nl : gRPC / ProtoBuf Support
• mstack.nl : Build and test your own .NET Aspire component

💻 Project Info

📦 NuGet packages

🔺 WireMock.Net.Minimal does not include WireMock.Net.MimePart, WireMock.Net.GraphQL, WireMock.Net.ProtoBuf, WireMock.Net.OpenTelemetry and WireMock.Net.Matchers.SystemTextJsonPath.

---

❗ Breaking changes

1.7.0

A breaking change is introduced which is related to System.Linq.Dynamic.Core DynamicLinq (CVE).

• The LinqMatcher is not allowed.
• The Handlebars.Net.Helpers.DynamicLinq package is not included anymore.

1.8.0

Some breaking changes are introduced in this version:

Handlebars.Net File-helper

By default, the internal Handlebars.Net File-helper is not allowed anymore because of potential security issues. To still enable this feature, you need to set the AllowedCustomHandlebarHelpers property to File in the HandlebarsSettings property in WireMockServerSettings.

Handlebars.Net Environment-helper

By default, the Handlebars.Net Environment-helper is not automatically allowed anymore because of potential security issues. To still enable this feature, you need to add the Environment category to the AllowedHandlebarsHelpers list-property in the HandlebarsSettings property in WireMockServerSettings.

---

📝 Development

For the supported frameworks and build information, see this page.

⭐ Stubbing

A core feature of WireMock.Net is the ability to return predefined HTTP responses for requests matching criteria. See Stubbing.

⭐ Request Matching

WireMock.Net support advanced request-matching logic, see Request Matching.

⭐ Response Templating

The response which is returned WireMock.Net can be changed using templating. This is described here Response Templating.

⭐ Admin API Reference

The WireMock admin API provides functionality to define the mappings via a http interface see Admin API Reference.

⭐ Using

WireMock.Net can be used in several ways:

UnitTesting

You can use your favorite test framework and use WireMock within your tests, see UnitTesting.

Unit/Integration Testing using Testcontainers.DotNet

See WireMock.Net.Testcontainers on how to build a WireMock.Net Docker container which can be used in Unit/Integration testing.

Unit/Integration Testing using an an Aspire Distributed Application

See WireMock.Net.Aspire on how to use WireMock.Net as an Aspire Hosted application to do Unit/Integration testing.

As a dotnet tool

It's simple to install WireMock.Net as (global) dotnet tool, see dotnet tool.

As standalone process / console application

This is quite straight forward to launch a mock server within a console application, see Standalone Process.

As a Windows Service

You can also run WireMock.Net as a Windows Service, follow this Windows Service.

As a Web Job in Azure or application in IIS

See this link WireMock-as-a-(Azure)-Web-App

In a docker container

There is also a Linux and Windows-Nano container available at hub.docker.com. For more details see also Docker.

HTTPS / SSL

More details on using HTTPS (SSL) can be found here HTTPS

📚 Documentation

For more info, see also this documentation page: What is WireMock.Net.

---

Powered by