SystemTextJsonPatch 3.1.0

dotnet add package SystemTextJsonPatch --version 3.1.0
NuGet\Install-Package SystemTextJsonPatch -Version 3.1.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="SystemTextJsonPatch" Version="3.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SystemTextJsonPatch --version 3.1.0
#r "nuget: SystemTextJsonPatch, 3.1.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.
// Install SystemTextJsonPatch as a Cake Addin
#addin nuget:?package=SystemTextJsonPatch&version=3.1.0

// Install SystemTextJsonPatch as a Cake Tool
#tool nuget:?package=SystemTextJsonPatch&version=3.1.0

SystemTextJsonPatchLogo

CI status Nuget

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

Build a patch document on the client. You can use the operations as described in the IETF document: Add, Remove, Replace, Copy, Move and Test.

JsonPatchDocument<DTO.Expense> expensePatch = new JsonPatchDocument<DTO.Expense>();
expensePatch.Replace(e => e.Description, expense.Description);

// serialize it to JSON
var expensePatchJson = System.Text.Json.JsonSerializer.Serialize(expensePatch);

On your API, in the patch method (accept document as parameter & use ApplyTo method)

[Route("api/expenses/{id}")]
[HttpPatch]
public IHttpActionResult Patch(
    int id,
    [FromBody] JsonPatchDocument<DTO.Expense> expensePatchDocument
)
{
      // get the expense from the repository
      var expense = _repository.GetExpense(id);

      // apply the patch document 
      expensePatchDocument.ApplyTo(expense);

      // changes have been applied to expense object
}

Migration from v1

JsonPatchDocumentConverterFactory no longer needs to be set to JsonSerializerOptions. Instead JsonPatchDocument types now use JsonConvertAttribute to use the correct converter.

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.10, Windows 11 (10.0.22621.2428/22H2/2022Update/SunValley2) AMD Ryzen 9 5950X, 1 CPU, 32 logical and 16 physical cores .NET SDK 8.0.100 [Host] : .NET 8.0.0 (8.0.23.53103), X64 RyuJIT AVX2 Job-NISUXQ : .NET 8.0.0 (8.0.23.53103), X64 RyuJIT AVX2

WarmupCount=2

Method Mean Error StdDev Gen0 Gen1 Allocated
SystemTextJsonPatch 3.1.0 4.043 us 0.0122 us 0.0109 us 0.2899 - 4.81 KB
MarvinJsonPatch 2.2.1 745.778 us 6.4053 us 6.2909 us 3.9063 1.9531 95.53 KB
AspNetCoreJsonPatch 8.0.0 16.294 us 0.0653 us 0.0611 us 2.6550 0.0610 43.61 KB
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 is compatible.  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 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. 
.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.
  • .NETStandard 2.0

  • net6.0

    • No dependencies.
  • net7.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on SystemTextJsonPatch:

Package Downloads
MediatR.CommandQuery

CQRS framework based on MediatR

Delobytes.AspNetCore.Swagger

Middlewares, MVC filters, extension methods and helper code for ASP.NET Core projects with Swagger (OpenAPI).

SurrealDb.Net

The official SurrealDB library for .NET

SystemTextJsonPatch.AspNet

SystemTextJsonPatch.AspNet contains JsonOptions extensions for ASP.NET Core

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on SystemTextJsonPatch:

Repository Stars
Azure/Bridge-To-Kubernetes
Bridge To Kubernetes (B2K) is development tool to debug microservices, pods which redirects traffic to your local development machine and vice versa.
Version Downloads Last updated
3.1.0 62,100 11/14/2023
3.0.1 49,217 8/21/2023
3.0.0 848 8/14/2023
2.0.2 16,613 7/16/2023
2.0.1 17,691 3/21/2023
2.0.0 245 3/21/2023
1.2.0 28,069 2/5/2023
1.1.0 7,571 1/18/2023
1.0.0 41,426 10/2/2022
0.0.9 7,168 9/11/2022
0.0.8 3,793 8/11/2022
0.0.7 2,863 6/17/2022
0.0.6 431 6/17/2022
0.0.5 2,266 5/24/2022
0.0.4 446 5/24/2022
0.0.3 443 5/23/2022
0.0.2 452 5/23/2022
0.0.1 819 5/19/2022