VeriJson 1.0.0

dotnet add package VeriJson --version 1.0.0
                    
NuGet\Install-Package VeriJson -Version 1.0.0
                    
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="VeriJson" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="VeriJson" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="VeriJson" />
                    
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 VeriJson --version 1.0.0
                    
#r "nuget: VeriJson, 1.0.0"
                    
#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 VeriJson@1.0.0
                    
#: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=VeriJson&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=VeriJson&version=1.0.0
                    
Install as a Cake Tool

VeriJson: Fluent JSON Assertions for .NET

VeriJson is a .NET library designed to make asserting JSON objects in your tests simple, intuitive, and highly readable. Using a fluent API, VeriJson leverages System.Text.Json to provide powerful and flexible assertions for your .NET applications.

Why VeriJson?

Testing JSON responses or documents can often lead to verbose and hard-to-maintain assertion code. VeriJson aims to solve this by:

  • Fluent Interface: Chainable methods that make your assertions read like natural language.
  • Clear Error Messaging: Get detailed error messages when assertions fail, pointing you directly to the discrepancy.
  • Configurability: Customize assertion behaviors like case sensitivity, handling of extra properties, and numeric precision.
  • Lightweight and Focused: Does one thing and does it well – JSON assertions.

Installation

VeriJson is available on NuGet. You can install it using the .NET CLI:

dotnet add package VeriJson

Or via the NuGet Package Manager:

Install-Package VeriJson

Getting Started

Once installed, you can start using VeriJson by adding the namespace and calling the Should() extension method on your JSON string or JsonElement.

Basic Usage

using VeriJson;
using System.Text.Json;

public class MyTests
{
    
    [Fact]
    public void SimpleJsonObject_Should_PassAssertions()
    {
        string json = @"{""name"":""Widget"", ""id"":123, ""active"":true}";
        string json2 = @"{""name"":""Widget"", ""active"":true, ""id"":123}";

        json.Should().BeEquivalentTo(json2)
    }
}
Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net9.0

    • No dependencies.

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 145 5/11/2025

ReleaseNotes.md