System Text Json Patch

SystemTextJsonPatch is a JSON Patch (JsonPatchDocument) RFC 6902 implementation for .NET using System.Text.Json

This library tries to ease the migration from Newtonsoft.Json to System.Text.Json by providing similar API for HttpPatch requests as in Microsoft.AspNetCore.JsonPatch and Marvin.JsonPatch

• Designed as an easy replacement for Microsoft.AspNetCore.JsonPatch
• Supports .NET 6 & netstandard2.0

Getting started

To enable JsonPatchDocument serialization support add SystemTextJsonPatch.Converters.JsonPatchDocumentConverterFactory to System.Text.Json serialization options converters. This is typically done in startup.cs file when configuring Asp.Net core MVC settings

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddControllers()
        .AddJsonOptions((options) =>
        {
            options.JsonSerializerOptions.Converters.Add(new SystemTextJsonPatch.Converters.JsonPatchDocumentConverterFactory());
        });
}

or when using System.Text.Json.JsonSerializer directly with custom settings.

    var jsonOptions = new JsonSerializerOptions()
    {
        Converters =
        {
            new SystemTextJsonPatch.Converters.JsonPatchDocumentConverterFactory()
        }
    };

    var json = System.Text.Json.JsonSerializer.JsonSerializer.Serialize(incomingOperations, jsonOptions);

Performance comparison

This test deserializes a JSON patch document of 8 operations and applies the changes to a new model.

See SystemTextJsonPatch.Benchmark for more details.

BenchmarkDotNet=v0.13.2, OS=Windows 11 (10.0.22000.978/21H2) AMD Ryzen 9 5950X, 1 CPU, 32 logical and 16 physical cores .NET SDK=7.0.100-rc.1.22431.12 [Host] : .NET 6.0.9 (6.0.922.41905), X64 RyuJIT AVX2 Job-URORCR : .NET 6.0.9 (6.0.922.41905), X64 RyuJIT AVX2

WarmupCount=2

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
SystemTextJsonPatch	7.233 us	0.0381 us	0.0356 us	0.3738	-	6.16 KB
MarvinJsonPatch	979.525 us	9.9310 us	8.8036 us	5.8594	3.9063	98.13 KB
AspNetCoreJsonPatch	26.645 us	0.2023 us	0.1892 us	2.5940	0.0610	42.49 KB