JsonPatch.Core 2.0.0

.NET Core 3.1
dotnet add package JsonPatch.Core --version 2.0.0
NuGet\Install-Package JsonPatch.Core -Version 2.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="JsonPatch.Core" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JsonPatch.Core --version 2.0.0
#r "nuget: JsonPatch.Core, 2.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install JsonPatch.Core as a Cake Addin
#addin nuget:?package=JsonPatch.Core&version=2.0.0

// Install JsonPatch.Core as a Cake Tool
#tool nuget:?package=JsonPatch.Core&version=2.0.0

JsonPatch

JsonPatch is a simple library that implements basic JSON Patch functionality as per RFC-6902 for .Net Core applications. It is not tied to ASP.Net, for that you should check out Michael McKenna's version on NuGet: https://www.nuget.org/packages/JsonPatch/

The library was converted from using Newtonsoft.Json to using the native .Net Core System.Text.Json.JsonSerializer. This saves ~700KB from the deployed size, which is welcome when writing Lambda functions. For more details see https://docs.microsoft.com/en-us/dotnet/standard/serialization/system-text-json-migrate-from-newtonsoft-how-to

Usage

public void Patch(Guid id, JsonPatchDocument<SomeDto> patchData)
{
    // Remember to do some validation and all that fun stuff
    var objectToUpdate = repository.GetById(id);
    patchData.ApplyUpdatesTo(objectToUpdate);
    repository.Save(objectToUpdate);
}

Options

The path specified in the patch request can be resolved to a different property on the model using a resolver.

E.g. the FlexiblePathResolver will match a property based on

  • The property name (case insensitive)
  • The DataMember attribute
    config.Formatters.Add(new JsonPatchFormatter(new JsonPatchSettings
    {
        PathResolver = new FlexiblePathResolver()
    }));

Now the patch

    [
        { "op": "add", "path": "/sampleProperty", "value": "foo" }
    ]

Will be valid for the class

    class Foo 
    {
        [DataMember(Name = "sampleProperty")] 
        public string MyProperty { get; set; }
    }

Available resolvers are

  • ExactCasePropertyPathResolver (default for backwards compatibility)
  • CaseInsensitivePropertyPathResolver
  • AttributePropertyPathResolver
  • FlexiblePathResolver

Notes

Because we are applying updates to C# objects rather than JSON objects we differ from the spec slightly, here are some points of difference.

JSON Pointer (rfc6901)

The JSON patch document uses JSON pointers to refer to properties, we don't accept paths in the following formats:

  1. The path "" is invalid as it refers to the whole object, if you're replacing everything, just use PUT.
  2. The path "/" is invalid as you cannot have an empty property.
  3. The path "/5" is invalid as you can only update an entity, not an array of entities.

Available operations (rfc6902#section-4)

We only support a subset of available operations at this moment: add, remove, and replace.

Since C# is a typed language we have a few restrictions, hence the operations work a little differently than specified in the specification.

Here's our flavour:

  1. Add will not add a property that does not exist, it can only be used to specify values on properties that are null.
  2. Remove will not remove a property, it will set its value to null.
  3. Replace will replace the value of a property even if it is null.

This is still very much an early project, don't use it in production yet unless you understand the source and don't mind fixing a few bugs 😉

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp3.1
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETCoreApp 3.1

    • 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
2.0.0 1,188 8/7/2020