WireMock.Net.Aspire
0.0.1-preview-05
Prefix Reserved
dotnet add package WireMock.Net.Aspire --version 0.0.1-preview-05
NuGet\Install-Package WireMock.Net.Aspire -Version 0.0.1-preview-05
<PackageReference Include="WireMock.Net.Aspire" Version="0.0.1-preview-05" />
paket add WireMock.Net.Aspire --version 0.0.1-preview-05
#r "nuget: WireMock.Net.Aspire, 0.0.1-preview-05"
// Install WireMock.Net.Aspire as a Cake Addin
#addin nuget:?package=WireMock.Net.Aspire&version=0.0.1-preview-05&prerelease
// Install WireMock.Net.Aspire as a Cake Tool
#tool nuget:?package=WireMock.Net.Aspire&version=0.0.1-preview-05&prerelease
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 | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | 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. |
-
net8.0
- Aspire.Hosting (>= 8.0.0)
- WireMock.Net.RestClient (>= 1.5.58)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.0.1-preview-05 | 34 | 6/25/2024 |
0.0.1-preview-04 | 52 | 6/4/2024 |
0.0.1-preview-03 | 45 | 6/3/2024 |
0.0.1-preview-02 | 45 | 5/29/2024 |
0.0.1-preview-01 | 49 | 5/24/2024 |
# 1.5.58 (08 June 2024)
- #1116 Add some methods to the BodyModelBuilder [feature]
- #1117 AbstractJsonPartialMatcher: Regex Value is Uppercased when IgnoreCase is set to true [bug]
The full release notes can be found here: https://github.com/WireMock-Net/WireMock.Net/blob/master/CHANGELOG.md