SystemTextJsonPatch 4.1.0
dotnet add package SystemTextJsonPatch --version 4.1.0
NuGet\Install-Package SystemTextJsonPatch -Version 4.1.0
<PackageReference Include="SystemTextJsonPatch" Version="4.1.0" />
paket add SystemTextJsonPatch --version 4.1.0
#r "nuget: SystemTextJsonPatch, 4.1.0"
// Install SystemTextJsonPatch as a Cake Addin #addin nuget:?package=SystemTextJsonPatch&version=4.1.0 // Install SystemTextJsonPatch as a Cake Tool #tool nuget:?package=SystemTextJsonPatch&version=4.1.0
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.
List<Operation<DTO.Expense>> operations = [];
JsonSerializerOptions jsonOptions = new JsonSerializerOptions();
JsonPatchDocument<DTO.Expense> expensePatch = new JsonPatchDocument<DTO.Expense>(operations, jsonOptions);
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
}
Deny access to properties
If you need to stop JsonPatch from reading or writing to some properties,
then you can decorate them with [DenyPatch]
, if a patch occurs that happens to access the property then a JsonPatchAccessDeniedException
is thrown.
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.14.0, Windows 11 (10.0.22631.4460/23H2/2023Update/SunValley3) AMD Ryzen 9 5950X, 1 CPU, 32 logical and 16 physical cores .NET SDK 9.0.100 [Host] : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2 Job-ZXROHW : .NET 9.0.0 (9.0.24.52809), X64 RyuJIT AVX2
WarmupCount=2
Method | Mean | Error | StdDev | Gen0 | Gen1 | Allocated |
---|---|---|---|---|---|---|
SystemTextJsonPatch | 3.641 us | 0.0168 us | 0.0149 us | 0.2747 | - | 4.63 KB |
MarvinJsonPatch | 701.319 us | 13.7540 us | 16.8912 us | 3.9063 | 1.9531 | 95.3 KB |
AspNetCoreJsonPatch | 14.871 us | 0.2871 us | 0.2820 us | 2.6245 | 0.0916 | 43.07 KB |
Product | Versions 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. net9.0 is compatible. |
.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. |
-
.NETStandard 2.0
- System.Text.Json (>= 9.0.0)
-
net6.0
- No dependencies.
-
net7.0
- No dependencies.
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (7)
Showing the top 5 NuGet packages that depend on SystemTextJsonPatch:
Package | Downloads |
---|---|
MediatR.CommandQuery
CQRS framework based on MediatR |
|
SurrealDb.Net
The official SurrealDB library for .NET |
|
Delobytes.AspNetCore.Swagger
Middlewares, MVC filters, extension methods and helper code for ASP.NET Core projects with Swagger (OpenAPI). |
|
SurrealDb.Reactive
Reactive Extensions for the SurrealDB library for .NET |
|
SurrealDb.Embedded.InMemory
In-memory provider for the SurrealDB library for .NET |
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 |
---|---|---|
4.1.0 | 7,548 | 11/15/2024 |
4.0.0 | 17,698 | 10/18/2024 |
3.3.0 | 165,498 | 10/5/2024 |
3.2.1 | 72,519 | 8/7/2024 |
3.2.0 | 62,920 | 5/30/2024 |
3.1.0 | 200,975 | 11/14/2023 |
3.0.1 | 69,808 | 8/21/2023 |
3.0.0 | 1,573 | 8/14/2023 |
2.0.2 | 18,372 | 7/16/2023 |
2.0.1 | 21,716 | 3/21/2023 |
2.0.0 | 274 | 3/21/2023 |
1.2.0 | 32,011 | 2/5/2023 |
1.1.0 | 9,673 | 1/18/2023 |
1.0.0 | 49,885 | 10/2/2022 |
0.0.9 | 7,204 | 9/11/2022 |
0.0.8 | 3,848 | 8/11/2022 |
0.0.7 | 2,969 | 6/17/2022 |
0.0.6 | 463 | 6/17/2022 |
0.0.5 | 2,311 | 5/24/2022 |
0.0.4 | 479 | 5/24/2022 |
0.0.3 | 475 | 5/23/2022 |
0.0.2 | 505 | 5/23/2022 |
0.0.1 | 1,084 | 5/19/2022 |