WireMock.Net 1.6.5

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package WireMock.Net --version 1.6.5
                    
NuGet\Install-Package WireMock.Net -Version 1.6.5
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="WireMock.Net" Version="1.6.5" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="WireMock.Net" Version="1.6.5" />
                    
Directory.Packages.props
<PackageReference Include="WireMock.Net" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add WireMock.Net --version 1.6.5
                    
#r "nuget: WireMock.Net, 1.6.5"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=WireMock.Net&version=1.6.5
                    
Install WireMock.Net as a Cake Addin
#tool nuget:?package=WireMock.Net&version=1.6.5
                    
Install WireMock.Net as a Cake Tool

WireMock.Net

Lightweight Http Mocking Server for .NET, inspired by WireMock.org (from the Java landscape).

⭐ 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

⭐ Stubbing

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

⭐ Request Matching

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

⭐ Response Templating

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

⭐ Admin API Reference

The WireMock admin API provides functionality to define the mappings via a http interface see Wiki : 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 Wiki : UnitTesting.

Unit/Integration Testing using Testcontainers.DotNet

See Wiki : 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 Wiki : 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 Wiki : dotnet tool.

As standalone process / console application

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

As a Windows Service

You can also run WireMock.Net as a Windows Service, follow this WireMock-as-a-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 Wiki : HTTPS

📚 Documentation

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

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net451 is compatible.  net452 is compatible.  net46 is compatible.  net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (24)

Showing the top 5 NuGet packages that depend on WireMock.Net:

Package Downloads
WireMock.Net.FluentAssertions

FluentAssertions extensions for WireMock.Net

WireMock.Net.StandAlone

Lightweight StandAlone Http Mocking Server for .Net.

Energinet.DataHub.Core.FunctionApp.TestCommon

[Release Notes](https://github.com/Energinet-DataHub/geh-core/blob/master/source/TestCommon/documents/release-notes/release-notes.md) [Documentation](https://github.com/Energinet-DataHub/geh-core/blob/master/source/TestCommon/documents/documentation.md)

WireMock.Net.Matchers.CSharpCode

A CSharpCodeMatcher which can be used to match WireMock.Net Requests using C# code.

Cortside.MockServer

Package Description

GitHub repositories (22)

Showing the top 20 popular GitHub repositories that depend on WireMock.Net:

Repository Stars
chocolatey/choco
Chocolatey - the package manager for Windows
restsharp/RestSharp
Simple REST and HTTP API Client for .NET
rabbitmq/rabbitmq-dotnet-client
RabbitMQ .NET client for .NET Standard 2.0+ and .NET 4.6.2+
CodeMazeBlog/CodeMazeGuides
The main repository for all the Code Maze guides
mehdihadeli/food-delivery-microservices
🍔 A practical and imaginary food delivery microservices, built with .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
open-telemetry/opentelemetry-dotnet-contrib
This repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.
SonarSource/sonar-scanner-msbuild
SonarScanner for .NET
influxdata/influxdb-client-csharp
InfluxDB 2.x C# Client
maxmind/GeoIP2-dotnet
MaxMind GeoIP2 .NET API
axzxs2001/Asp.NetCoreExperiment
原来所有项目都移动到**OleVersion**目录下进行保留。新的案例装以.net 5.0为主,一部分对以前案例进行升级,一部分将以前的工作经验总结出来,以供大家参考!
JasonBock/Rocks
A mocking library based on the Compiler APIs (Roslyn + Mocks)
dotnetrdf/dotnetrdf
dotNetRDF is a powerful and flexible API for working with RDF and SPARQL in .NET environments
hassanhabib/Standard.AI.OpenAI
Standard-Compliant .NET library for Open AI
hassanhabib/RESTFulSense
A RESTFul operations client that serializes responses and throws meaningful exceptions for >= 400 status codes.
mehdihadeli/vertical-slice-api-template
🍰 An asp.net core template based on .Net 9, Vertical Slice Architecture, CQRS, Minimal APIs, OpenTelemetry, API Versioning and OpenAPI.
notion-dotnet/notion-sdk-net
A Notion SDK for .Net
basdijkstra/rest-assured-net
C# DSL for writing readable tests for HTTP-based APIs
okta/okta-sdk-dotnet
A .NET SDK for interacting with the Okta management API, enabling server-side code to manage Okta users, groups, applications, and more.
jodendaal/OpenAI.Net
OpenAI library for .NET
mdesalvo/RDFSharp
Lightweight and friendly .NET library for realizing Semantic Web applications (RDF, SPARQL, SHACL)
Version Downloads Last updated
1.8.6 12,246 5/15/2025
1.8.5 7,396 5/14/2025
1.8.4 24,505 5/8/2025
1.8.3 15,967 5/6/2025
1.8.2 10,634 5/5/2025
1.8.1 14,320 5/2/2025
1.8.0 11,338 4/29/2025
1.8.0-prview-01 10,697 3/4/2025
1.7.5-preview-02 414 4/3/2025
1.7.5-preview-01 293 4/2/2025
1.7.4 591,174 2/27/2025
1.7.3 37,915 2/24/2025
1.7.2 160,179 2/12/2025
1.7.2-preview-01 966 2/7/2025
1.7.1 223,955 1/27/2025
1.7.0 139,605 1/22/2025
1.6.12 26,041 1/21/2025
1.6.11 233,527 1/2/2025
1.6.10 157,318 12/15/2024
1.6.9 112,506 12/6/2024
1.6.8 258,499 11/24/2024
1.6.7 569,369 10/17/2024
1.6.7-preview-02 1,899 10/6/2024
1.6.7-preview-01 314 10/2/2024
1.6.6 259,028 10/1/2024
1.6.5 120,440 9/28/2024
1.6.4 51,606 9/25/2024
1.6.3 340,418 9/7/2024
1.6.2 67,861 9/4/2024
1.6.1 214,894 8/22/2024
1.6.0 117,781 8/16/2024
1.5.62 399,007 7/27/2024
1.5.61 1,481 7/27/2024
1.5.60 372,662 7/9/2024
1.5.59 147,245 6/26/2024
1.5.58 254,393 6/8/2024
1.5.57 56,132 6/4/2024
1.5.56 66,464 6/3/2024
1.5.55 175,798 5/22/2024
1.5.54 64,206 5/18/2024
1.5.53 211,785 5/8/2024
1.5.52 583,898 4/6/2024
1.5.51 291,736 3/20/2024
1.5.50 1,829 3/20/2024
1.5.49 340,935 3/6/2024
1.5.48 288,997 2/17/2024
1.5.47 578,425 1/25/2024
1.5.46 560,331 12/23/2023
1.5.45 33,746 12/21/2023
1.5.44 71,928 12/14/2023
1.5.43 103,140 12/11/2023
1.5.42 19,201 12/9/2023
1.5.41 101,486 12/4/2023
1.5.40 377,124 11/7/2023
1.5.39 405,057 10/9/2023
1.5.38 2,009 10/9/2023
1.5.37 133,877 9/27/2023
1.5.36 585,399 9/21/2023
1.5.35 455,957 8/19/2023
1.5.34 220,961 8/4/2023
1.5.32 501,809 7/15/2023
1.5.31 129,702 7/8/2023
1.5.30 206,105 6/28/2023
1.5.29 98,143 6/22/2023
1.5.28 305,051 6/11/2023
1.5.27 84,539 6/3/2023
1.5.26 305,818 5/25/2023
1.5.25 275,386 5/13/2023
1.5.24 142,370 5/7/2023
1.5.23 167,016 4/23/2023
1.5.22 355,020 4/8/2023
1.5.21 198,631 3/22/2023
1.5.20 63,009 3/19/2023
1.5.19 5,142 3/17/2023
1.5.18 105,613 3/9/2023
1.5.17 103,570 2/25/2023
1.5.16 284,020 2/6/2023
1.5.15 138,641 1/29/2023
1.5.14 33,918 1/24/2023
1.5.13 663,715 12/11/2022
1.5.12 99,041 12/3/2022
1.5.11 77,025 11/24/2022
1.5.10 409,197 11/6/2022
1.5.9 78,132 10/29/2022
1.5.8 181,158 10/16/2022
1.5.7 79,830 10/11/2022
1.5.6 448,747 9/12/2022
1.5.5 77,824 9/3/2022
1.5.4 91,980 8/24/2022
1.5.3 269,627 7/29/2022
1.5.2 52,210 7/24/2022
1.5.1 168,138 7/8/2022
1.5.0 294,273 6/10/2022
1.4.43 306,545 5/21/2022
1.4.42 214,843 5/13/2022
1.4.41 295,662 4/22/2022
1.4.40 394,469 3/26/2022
1.4.39 5,185 3/25/2022
1.4.38 117,864 3/12/2022
1.4.37 91,603 3/2/2022
1.4.36 14,427 2/25/2022
1.4.35 135,870 2/9/2022
1.4.34 251,942 1/27/2022
1.4.33 10,684 1/24/2022
1.4.32 91,970 1/17/2022
1.4.31 95,013 1/6/2022
1.4.30 70,571 12/25/2021
1.4.29 127,665 12/12/2021
1.4.28 78,278 12/1/2021
1.4.27 140,550 11/17/2021
1.4.26 168,625 11/4/2021
1.4.25 52,322 10/27/2021
1.4.24 37,768 10/20/2021
1.4.23 1,032,250 9/27/2021
1.4.22 46,889 9/22/2021
1.4.21 156,567 9/16/2021
1.4.20 326,847 8/6/2021
1.4.19 12,969 8/4/2021
1.4.18 158,343 7/10/2021
1.4.17 9,238 7/7/2021
1.4.16 273,051 6/5/2021
1.4.15 109,354 5/19/2021
1.4.14 93,347 5/11/2021
1.4.13 64,246 4/26/2021
1.4.12 31,170 4/22/2021
1.4.11 22,284 4/18/2021
1.4.10 18,862 4/15/2021
1.4.9 72,693 3/31/2021
1.4.8 97,661 3/24/2021
1.4.7 14,253 3/21/2021
1.4.6 141,186 2/26/2021
1.4.5 101,147 2/11/2021
1.4.4 12,431 2/9/2021
1.4.3 34,271 2/5/2021
1.4.2 44,946 1/24/2021
1.4.1 20,625 1/19/2021
1.4.0 38,579 1/12/2021
1.3.10 93,373 12/23/2020
1.3.9 96,901 12/8/2020
1.3.8 16,188 12/3/2020
1.3.7 97,924 11/17/2020
1.3.6 25,370 11/10/2020
1.3.5 13,754 11/4/2020
1.3.4 201,210 10/17/2020
1.3.3 7,113 10/15/2020
1.3.2 10,163 10/14/2020
1.3.1 79,478 9/30/2020
1.3.0 27,486 9/29/2020
1.2.18 415,321 8/13/2020
1.2.17 27,293 8/1/2020
1.2.16 53,211 7/27/2020
1.2.15 52,440 7/19/2020
1.2.14 195,922 7/9/2020
1.2.13 3,331 7/9/2020
1.2.12 187,931 5/23/2020
1.2.11 13,096 5/18/2020
1.2.10 4,174 5/17/2020
1.2.9 15,638 5/14/2020
1.2.8 28,591 5/4/2020
1.2.7 6,330 4/30/2020
1.2.6 8,265 4/29/2020
1.2.5 101,814 4/17/2020
1.2.4 17,607 4/10/2020
1.2.3 96,607 4/1/2020
1.2.2 39,068 3/25/2020
1.2.1 33,488 3/17/2020 1.2.1 is deprecated because it has critical bugs.
1.2.0 5,739 3/14/2020 1.2.0 is deprecated because it has critical bugs.
1.1.10 20,548 3/5/2020
1.1.9 31,904 2/25/2020
1.1.8 7,960 2/22/2020
1.1.7 57,526 2/6/2020
1.1.6 22,913 1/27/2020
1.1.5 5,724 1/25/2020
1.1.4 3,011 1/25/2020
1.1.3 19,457 1/22/2020
1.1.2 28,519 1/9/2020
1.1.1 3,184 1/9/2020
1.1.0 48,222 12/27/2019
1.0.43 12,325 12/26/2019
1.0.42 63,424 12/15/2019
1.0.41 3,284 12/14/2019
1.0.40 21,135 12/9/2019
1.0.39 3,649 12/7/2019
1.0.38 24,028 11/30/2019
1.0.37 162,696 11/8/2019
1.0.36 43,937 10/26/2019
1.0.36-ci-12100 2,300 11/18/2019
1.0.35 25,651 10/25/2019
1.0.34 35,462 10/22/2019
1.0.33 16,762 10/12/2019
1.0.32 99,127 9/20/2019
1.0.31 4,436 9/19/2019
1.0.30 50,768 9/1/2019
1.0.29 31,109 8/23/2019
1.0.28 8,781 8/20/2019
1.0.27 11,292 8/14/2019
1.0.26 42,730 8/11/2019
1.0.25 37,829 7/23/2019
1.0.24 6,736 7/22/2019
1.0.23 24,008 7/16/2019
1.0.22 10,497 7/15/2019
1.0.20 61,713 6/17/2019
1.0.19 3,626 6/15/2019
1.0.18 57,829 6/10/2019
1.0.17 13,151 6/5/2019
1.0.16 48,848 5/16/2019
1.0.15 36,443 5/4/2019
1.0.14 22,432 4/20/2019
1.0.13 19,484 4/11/2019
1.0.12 71,564 4/5/2019
1.0.11 5,907 3/30/2019
1.0.10 6,060 3/27/2019
1.0.9 9,604 3/25/2019
1.0.8 41,058 3/12/2019
1.0.7 73,980 1/19/2019
1.0.6.1 13,774 1/10/2019
1.0.6 14,388 12/15/2018
1.0.5 11,014 12/7/2018
1.0.4.21 30,527 11/30/2018
1.0.4.20 56,253 11/7/2018
1.0.4.19 29,709 10/31/2018
1.0.4.18 15,795 10/27/2018
1.0.4.17 43,250 9/22/2018
1.0.4.16 201,272 9/11/2018
1.0.4.15 5,391 9/4/2018
1.0.4.14 6,590 9/2/2018
1.0.4.13 3,788 8/31/2018
1.0.4.12 5,829 8/23/2018
1.0.4.11 4,152 8/20/2018
1.0.4.10 40,532 8/14/2018
1.0.4.9 5,776 8/8/2018
1.0.4.8 22,409 7/23/2018
1.0.4.7 4,906 7/19/2018
1.0.4.6 5,375 7/18/2018
1.0.4.5 7,536 7/17/2018
1.0.4.4 16,819 7/1/2018
1.0.4.3 3,971 6/29/2018
1.0.4.2 6,674 6/26/2018
1.0.4.1 4,804 6/25/2018
1.0.4 16,425 6/23/2018
1.0.3.20 40,625 5/29/2018
1.0.3.19 4,460 5/28/2018
1.0.3.18 4,261 5/25/2018
1.0.3.17 13,192 5/16/2018
1.0.3.16 23,360 4/15/2018
1.0.3.15 12,951 4/5/2018
1.0.3.14 4,465 4/1/2018
1.0.3.13 38,342 3/24/2018
1.0.3.11 5,976 3/20/2018
1.0.3.10 7,761 3/17/2018
1.0.3.9 5,182 3/15/2018
1.0.3.8 9,386 3/10/2018
1.0.3.7 4,654 3/9/2018
1.0.3.6 3,851 3/8/2018
1.0.3.5 4,881 3/8/2018
1.0.3.4 4,878 3/4/2018
1.0.3.3 6,004 2/24/2018
1.0.3.2 25,461 2/14/2018
1.0.3.1 3,771 2/14/2018
1.0.3 9,803 2/5/2018
1.0.2.13 15,441 1/23/2018
1.0.2.12 5,435 1/16/2018
1.0.2.11 15,482 12/20/2017
1.0.2.10 5,007 12/12/2017
1.0.2.9 5,817 12/7/2017
1.0.2.8 6,108 11/23/2017
1.0.2.7 4,839 11/18/2017
1.0.2.6 4,934 10/30/2017
1.0.2.5 4,039 10/24/2017
1.0.2.4 21,987 10/10/2017
1.0.2.4-preview-02 3,682 9/30/2017
1.0.2.4-preview-01 3,284 8/11/2017
1.0.2.3 22,186 8/8/2017
1.0.2.3-preview2-final-03 3,075 8/10/2017
1.0.2.3-preview2-final-02 2,939 8/10/2017
1.0.2.3-preview2-final-01 3,064 8/10/2017
1.0.2.1 3,943 6/14/2017
1.0.2 9,084 5/5/2017
1.0.1.5 12,603 3/21/2017
1.0.1.4 2,925 3/21/2017
1.0.1.2 2,827 2/27/2017
1.0.1.1 2,834 2/10/2017
1.0.0 20,753 1/24/2017

# 1.6.5 (28 September 2024)
- #1175 Add WireMock.Net.AspNetCore.Middleware [feature]
- #1181 WireMock.Net.Testcontainers: Use 'sheyenrath/wiremock.net-alpine' image as default for Linux [feature]
- #1182 pass in the request when no matching is found to the warn logger [feature]

The full release notes can be found here: https://github.com/WireMock-Net/WireMock.Net/blob/master/CHANGELOG.md