Skip to content

WireMock.Net is a flexible product for stubbing and mocking web HTTP responses using advanced request matching and response templating. Based on the functionality from http://WireMock.org, but extended with more functionality.

License

NotificationsYou must be signed in to change notification settings

wiremock/WireMock.Net

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

WireMock.Net

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

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

⭐ 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

📝 Blogs

💻 Project Info

Project 
  ChatSlackGitter
  IssuesGitHub issues
Quality 
  Build AzureBuild Status Azure
  QualitySonar Quality GateCodeFactor
  Sonar BugsSonar BugsSonar Code Smells
  CoverageSonar Coveragecodecov
  TIOBETIOBE Quality Indicator

📦 NuGet packages

OfficialPreview ℹ️
  WireMock.NetNuGet Badge WireMock.NetMyGet Badge WireMock.Net
  WireMock.Net.StandAloneNuGet Badge WireMock.NetMyGet Badge WireMock.Net.StandAlone
  WireMock.Net.TestcontainersNuGet Badge WireMock.Net.TestcontainersMyGet Badge WireMock.Net.Testcontainers
  WireMock.Net.AspireNuGet Badge WireMock.Net.AspireMyGet Badge WireMock.Net.Aspire
  WireMock.Net.AspNetCore.MiddlewareNuGet Badge WireMock.Net.AspNetCore.MiddlewareMyGet Badge WireMock.Net.AspNetCore.Middleware
  WireMock.Net.AwesomeAssertionsNuGet Badge WireMock.Net.AwesomeAssertionsMyGet Badge WireMock.Net.AwesomeAssertions
  WireMock.Net.FluentAssertionsNuGet Badge WireMock.Net.FluentAssertionsMyGet Badge WireMock.Net.FluentAssertions
  WireMock.Net.xUnitNuGet Badge WireMock.Net.xUnitMyGet Badge WireMock.Net.xUnit
  WireMock.Net.TUnitNuGet Badge WireMock.Net.TUnitMyGet Badge WireMock.Net.TUnit
  WireMock.Net.Matchers.CSharpCodeNuGet Badge WireMock.Net.Matchers.CSharpCodeMyGet Badge WireMock.Net.Matchers.CSharpCode
  WireMock.Net.OpenApiParserNuGet Badge WireMock.Net.OpenApiParserMyGet Badge WireMock.Net.OpenApiParser
  WireMock.Net.RestClientNuGet Badge WireMock.Net.RestClientMyGet Badge WireMock.Net.RestClient
  WireMock.Org.RestClientNuGet Badge WireMock.Org.RestClientMyGet Badge WireMock.Org.RestClient

❗ Breaking changes

1.7.0

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

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 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

About

WireMock.Net is a flexible product for stubbing and mocking web HTTP responses using advanced request matching and response templating. Based on the functionality from http://WireMock.org, but extended with more functionality.

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages