JsonValidator.FluentAssertions 1.0.4

There is a newer version of this package available.
See the version list below for details.
dotnet add package JsonValidator.FluentAssertions --version 1.0.4                
NuGet\Install-Package JsonValidator.FluentAssertions -Version 1.0.4                
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="JsonValidator.FluentAssertions" Version="1.0.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JsonValidator.FluentAssertions --version 1.0.4                
#r "nuget: JsonValidator.FluentAssertions, 1.0.4"                
#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 JsonValidator.FluentAssertions as a Cake Addin
#addin nuget:?package=JsonValidator.FluentAssertions&version=1.0.4

// Install JsonValidator.FluentAssertions as a Cake Tool
#tool nuget:?package=JsonValidator.FluentAssertions&version=1.0.4                

{✓} JSON Validator

This project provides a simple way to validate JSON objects in dotnet. The main use for the tool is in integration tests where you would — ideally — validate an API JSON response manually instead of using the model classes.

Build Status Coverage License: MIT pull requests: welcome

NuGet packages:

Nuget: JsonValidator Nuget: JsonValidator.FluentAssertions

Usage of JsonValidator

  • Parse the JSON string to a System.Text.Json.JsonDocument
  • Define the object with the properties you would like to validate. This can be a regular class or an anonymous class as well. We recommend anonymous classes.
  • Call the ValidateMatch extension method on the JsonDocument.
  • The ValidateMatch will throw a ValidationFailedException if any value of the above defined object is not present or does not match the value in the JsonDocument.
  • Values that are present in the JsonDocument but are not defined in the validation object are ignored. They will not influence the validation result.

Example

JsonDocument.Parse(
        """
        {
          "name": "Anna Smith",
          "title": null,
          "level": 2,
          "isAvailable": true,
          "score": 4.5326,
          "capabilities": ["accounting", "marketing", "sales"],                      
          "personalData":
          {
            "age": 29,
            "nickname": "Anny",
            "isMarried": false
          }
        }
        """)
    .ValidateMatch(
        new
        {
            name = "Anna Smith",
            title = null as string,
            level = 2,
            isAvailable = true,
            score = 4.5326,
            capabilities = new[] { "accounting", "marketing", "sales" },
            personalData = new
            {
                age = 29,
                nickname = "Anny",
                isMarried = false,
            }
        });

Usage of JsonValidator.FluentAssertions

  • The JsonValidator.FluentAssertions package depends on and uses both FluentAssertions and the basic JsonValidator package.
  • This package provides extensions that can be accessed through FluentAssertions' Should() method.
  • Available extensions:
    • for System.Text.Json.JsonDocument: Match(...) checks whether the JSON document matches the input object in both structure and values.
    • for System.Net.Http.HttpResponseMessage: HaveJsonBody(...) checks whether the HTTP response's body as a JSON string matches the input object in both structure and values.

Examples

For JsonDocument:

var json = JsonDocument.Parse(myJsonString);

json.Should().Match(
  new
  {
      name = "Anna Smith",
      level = 2,
  },
  "Because...");

For HttpResponseMessage:

HttpResponseMessage response = await _client.SendAsync(request);

response.Should().HaveJsonBody(
  new
  {
      name = "Anna Smith",
      level = 2,
  },
  "Because...");
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. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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.1.1 3,452 5/9/2024
1.1.0 563 3/4/2024
1.0.4 2,230 1/9/2024
1.0.3 88 1/9/2024