WireMock.Net Documentation

The WireMock.Net WebSocket examples demonstrate several key capabilities:

• Echo Server: Returns all received messages back to the client.
• Custom Message Handlers: Implements complex logic (e.g., a chat server with commands like /help, /time, /upper).
• Broadcast: Sends messages received from one client to all other connected clients.
• Scenarios/State Machines: Manages state transitions (e.g., a game server moving from Lobby -> Playing -> GameOver).
• WebSocket Proxy: Forwards WebSocket connections to external servers (e.g., echo.websocket.org).
• Protocol Negotiation: Supports Sec-WebSocket-Protocol negotiation.
• JSON Messaging: Handles structured data exchange.
• Connection Management: Tracks and manages active connections and states.

To enable OpenTelemetry tracing and OTLP exporting for WireMock.Net, install the WireMock.Net.OpenTelemetry NuGet package.

Requirements:

• .NET 6.0 or later
• WireMock.Net 1.6.0 or later

dotnet add package WireMock.Net.OpenTelemetry

If you require manual control over your TracerProvider configuration, you can use the AddWireMockInstrumentation extension method on a TracerProviderBuilder. This adds the WireMock.Net ActivitySource to your existing tracing pipeline.

using OpenTelemetry;
using OpenTelemetry.Trace;
using WireMock.OpenTelemetry;

var openTelemetryOptions = new OpenTelemetryOptions();

// Configure your own TracerProvider
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddWireMockInstrumentation(openTelemetryOptions) // Adds WireMock.Net source
    .AddOtlpExporter(options =>
    {
        options.Endpoint = new Uri("http://localhost:4317");
    })
    .Build();

The wscat CLI tool is recommended for manual testing of WebSocket endpoints. You can connect to standard endpoints, specify sub-protocols, or include custom headers.

Common commands:

Connect to a standard echo endpoint:

wscat -c ws://localhost:9091/ws/echo

Connect using a specific sub-protocol:

wscat -c ws://localhost:9091/ws/protocol -s chat

Connect with custom HTTP headers:

wscat -c ws://localhost:9091/ws/echo -H "X-Custom-Header: value"

To run a WireMock.Net Web Application within Internet Information Services (IIS), you must configure the hosting environment for ASP.NET Core. This typically involves:

1. Following standard ASP.NET Core deployment patterns for IIS.
2. Creating a web.config file in the application root to define the IIS handler and module settings.

For detailed deployment guidance, refer to the Microsoft documentation on IIS support for ASP.NET Core or West Wind's guides on publishing ASP.NET Core applications to IIS.

To run the WebSocket demonstration project, ensure you have the .NET 8.0 SDK installed. Navigate to the example directory and use the dotnet run command.

Prerequisites:

• .NET 8.0 SDK
• Optional: wscat for manual testing (npm install -g wscat)

Execution:

cd examples/WireMock.Net.WebSocketExamples
dotnet run

To use the minimal-API-style routing extensions with WireMock.Net, install the package via NuGet.

dotnet add package WireMock.Net.Extensions.Routing

To begin using the routing extensions, start a WireMockServer and wrap it in a WireMockRouter. You can then use MapGet to define simple endpoints that return strings or other objects.

using System.Net.Http.Json;
using WireMock.Net.Extensions.Routing;
using WireMock.Net.Extensions.Routing.Extensions;
using WireMock.Server;

var server = WireMockServer.Start();
var router = new WireMockRouter(server);

router.MapGet("/hello", _ => "Hello, world!");

using var client = server.CreateClient();
var result = await client.GetFromJsonAsync<string>("/hello");
// Hello, world!