WireMock.Net.Aspire 1.6.7-preview-01

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of WireMock.Net.Aspire.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package WireMock.Net.Aspire --version 1.6.7-preview-01                

                    
                

            
NuGet\Install-Package WireMock.Net.Aspire -Version 1.6.7-preview-01
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.Aspire" Version="1.6.7-preview-01" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add WireMock.Net.Aspire --version 1.6.7-preview-01                

                    
                

            
#r "nuget: WireMock.Net.Aspire, 1.6.7-preview-01"
#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. 
// Install WireMock.Net.Aspire as a Cake Addin
#addin nuget:?package=WireMock.Net.Aspire&version=1.6.7-preview-01&prerelease

// Install WireMock.Net.Aspire as a Cake Tool
#tool nuget:?package=WireMock.Net.Aspire&version=1.6.7-preview-01&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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.7 279 10/17/2024
1.6.7-preview-02 91 10/6/2024
1.6.7-preview-01 66 10/2/2024
1.6.6 103 10/1/2024
1.6.5 88 9/28/2024
1.6.4 87 9/25/2024
1.6.3 196 9/7/2024
1.6.2 91 9/4/2024
1.6.1 121 8/29/2024
1.6.0 101 8/29/2024
0.0.1-preview-05 343 6/25/2024
0.0.1-preview-04 112 6/4/2024
0.0.1-preview-03 92 6/3/2024
0.0.1-preview-02 95 5/29/2024
0.0.1-preview-01 99 5/24/2024

# 1.6.6 (01 October 2024)
- #1185 Throw exception in case WithTransformer is used after WithBodyFromFile [bug]
- #1187 Fix StaticMappingsPath in WireMockContainerBuilder [bug]
- #1184 .WithBodyFromFile() + .WithTransformer(transformContentFromBodyAsFile: true) = empty string [bug]
- #1186 WithMappings path is null on Build() call [bug]

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