Shouldly.Json 0.0.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Shouldly.Json --version 0.0.2
                    


                    

                
NuGet\Install-Package Shouldly.Json -Version 0.0.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.Json" Version="0.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Shouldly.Json" Version="0.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Shouldly.Json" />
                    


                            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.Json --version 0.0.2
                    


                    

                
#r "nuget: Shouldly.Json, 0.0.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. 
#addin nuget:?package=Shouldly.Json&version=0.0.2
                    


                            Install Shouldly.Json as a Cake Addin
                        

                    

                
#tool nuget:?package=Shouldly.Json&version=0.0.2
                    


                            Install Shouldly.Json as a Cake Tool

Shouldly.Json Nuget

Coverage Quality Gate Status Maintainability Rating Reliability Rating Security Rating Vulnerabilities

Shouldly.Json was created by, and is maintained by Marvin Mall. It provides extension methods for the Shouldly library to compare JSON strings.

Installation

The package can be found on nuget.org. You can install the package with:

Install-Package Shouldly.Json

Usage

The library provides multiple methods for comparing JSON strings.

Semantic JSON Equality

Use ShouldBeSemanticallySameJson() to compare two JSON strings for semantic equality. This means:

  • Property order in objects doesn't matter
  • Whitespace and formatting doesn't matter
  • Numbers with same value but different representation (e.g., 1.0 and 1.00) are considered equal
  • Array order matters
var json1 = @"{""name"": ""John"", ""age"": 30}";
var json2 = @"{""age"": 30, ""name"": ""John""}";
var json3 = @"{""name"": ""John"", ""age"": 31}";

json1.ShouldBeSemanticallySameJson(json2); // Succeeds
json1.ShouldBeSemanticallySameJson(json3); // Fails

JSON Subtree Matching

Use ShouldBeJsonSubtreeOf() to verify that one JSON structure is contained within another. This means:

  • The actual JSON must be a subset of the expected JSON
  • Missing properties in objects are allowed
  • Arrays must match exactly (including length and order), but objects in arrays are handled like other objects
var json1 = @"{""name"": ""John""}";
var json2 = @"{""name"": ""John"", ""age"": 30}";
var json3 = @"{""name"": ""Adrian""}";
var json4 = @"{""firstName"": ""John""}";

json1.ShouldBeJsonSubtreeOf(json2); // Succeeds
json1.ShouldBeJsonSubtreeOf(json3); // Fails
json1.ShouldBeJsonSubtreeOf(json4); // Fails

License

This library is open-sourced software licensed under the MIT license.

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.  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. 
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
0.3.0 1,457 2 months ago
0.2.0 314 2 months ago
0.1.0 75 2 months ago
0.0.2 81 2 months ago

https://github.com/Namoshek/Shouldly.Json/releases/tag/v0.0.2