Shouldly.Web 1.0.0-preview.2

This is a prerelease version of Shouldly.Web.
dotnet add package Shouldly.Web --version 1.0.0-preview.2
                    
NuGet\Install-Package Shouldly.Web -Version 1.0.0-preview.2
                    
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="Shouldly.Web" Version="1.0.0-preview.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shouldly.Web" Version="1.0.0-preview.2" />
                    
Directory.Packages.props
<PackageReference Include="Shouldly.Web" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Shouldly.Web --version 1.0.0-preview.2
                    
#r "nuget: Shouldly.Web, 1.0.0-preview.2"
                    
#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.
#:package Shouldly.Web@1.0.0-preview.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Shouldly.Web&version=1.0.0-preview.2&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Shouldly.Web&version=1.0.0-preview.2&prerelease
                    
Install as a Cake Tool

Shouldly.Web

A Shouldly extension over the HttpResponseMessage object. It provides HTTP-specific assertions whose failure messages include the HTTP Request and Response, so test failures show the whole conversation and less time with debugging is spent.

This is an unofficial, community-maintained extension and is not endorsed by the Shouldly project. It requires Shouldly >= 5.0.0-preview.2 and is itself a prerelease until Shouldly 5.0.0 is stable.

Install

dotnet add package Shouldly.Web

Example

With Shouldly the assertions are called directly on the response, and unlike the FluentAssertions/AwesomeAssertions flavours there is no Should()/And chain — each assertion is its own call:

[Fact]
public async Task Post_ReturnsOk()
{
    // Arrange
    var client = _factory.CreateClient();

    // Act
    var response = await client.PostAsync("/api/comments", new StringContent(
    """
    {
      "author": "John",
      "content": "Hey, you..."
    }
    """, Encoding.UTF8, "application/json"));

    // Assert
    response.ShouldBe200Ok();
}

When the assertion fails, the test output follows the Shouldly layout (should be/but was) and continues with the complete HTTP response and the originating HTTP request.

Reporting every failing assertion

Pass the assertions of a ShouldSatisfy check as a collection of conditions and every failing one is reported, not only the first:

response.ShouldSatisfy([
    r => r.ShouldHaveHeader("X-Correlation-ID"),
    r => r.Headers.AcceptRanges.ShouldContain("byte")]);

Each failing condition appears as its own Error 1, Error 2, … block, matching what FluentAssertions reports for a multi-statement lambda. A single assertion lambda runs as one condition and stops at its first failure, so when migrating from FluentAssertions pass the statements of its body as the condition list instead.

Documentation

The shared Assertions.Web documentation describes the assertions at a glance, the failure output and the configuration. The Shouldly.Web section of the repository readme maps every FluentAssertions assertion name to its Shouldly counterpart, and the Shouldly.Web Examples and Shouldly.Web API sections list them in detail.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-preview.2 37 10/9/2026
1.0.0-preview.1 36 10/8/2026