WireMock.Net.Aspire
1.6.8
Prefix Reserved
dotnet add package WireMock.Net.Aspire --version 1.6.8
NuGet\Install-Package WireMock.Net.Aspire -Version 1.6.8
<PackageReference Include="WireMock.Net.Aspire" Version="1.6.8" />
paket add WireMock.Net.Aspire --version 1.6.8
#r "nuget: WireMock.Net.Aspire, 1.6.8"
// Install WireMock.Net.Aspire as a Cake Addin #addin nuget:?package=WireMock.Net.Aspire&version=1.6.8 // Install WireMock.Net.Aspire as a Cake Tool #tool nuget:?package=WireMock.Net.Aspire&version=1.6.8
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.2.2)
- System.Text.RegularExpressions (>= 4.3.1)
- WireMock.Net.RestClient (>= 1.6.8)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on WireMock.Net.Aspire:
Repository | Stars |
---|---|
thangchung/practical-dotnet-aspire
The practical .NET Aspire builds on the coffeeshop app business domain
|
Version | Downloads | Last updated |
---|---|---|
1.6.8 | 0 | 11/24/2024 |
1.6.7 | 336 | 10/17/2024 |
1.6.7-preview-02 | 93 | 10/6/2024 |
1.6.7-preview-01 | 68 | 10/2/2024 |
1.6.6 | 105 | 10/1/2024 |
1.6.5 | 90 | 9/28/2024 |
1.6.4 | 89 | 9/25/2024 |
1.6.3 | 198 | 9/7/2024 |
1.6.2 | 93 | 9/4/2024 |
1.6.1 | 123 | 8/29/2024 |
1.6.0 | 104 | 8/29/2024 |
0.0.1-preview-05 | 345 | 6/25/2024 |
0.0.1-preview-04 | 114 | 6/4/2024 |
0.0.1-preview-03 | 94 | 6/3/2024 |
0.0.1-preview-02 | 97 | 5/29/2024 |
0.0.1-preview-01 | 101 | 5/24/2024 |
# 1.6.8 (23 November 2024)
- #1202 Log exception when (static) mapping file cannot be read [feature]
- #1206 Fix security issues [bug]
- #1211 Use GraphQL 8.2.1 [feature]
- #1213 Fix HandlebarsContext ParseAndEvaluate method [bug]
- #1201 Mapping file parse errors are not logged to the console [feature]
- #1209 Upgrade of GraphQL libs to the latest [feature]
- #1212 Response Body Does Not Include Text After Path Segment [bug]
The full release notes can be found here: https://github.com/WireMock-Net/WireMock.Net/blob/master/CHANGELOG.md