Class JsonPatch

Provides functionality for applying a JSON Patch as defined in RFC 6902 to a JSON value.

Inheritance

System.Object

JsonPatch

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: JsonCons.Utilities

Assembly: JsonCons.Utilities.dll

Syntax

public static class JsonPatch

Examples

The following example borrowed from jsonpatch.com shows how to apply a JSON Patch to a JSON value

using System;
using System.Diagnostics;
using System.Text.Json;
using JsonCons.Utilities;

public class Example
{
   public static void Main()
   {
    using var doc = JsonDocument.Parse(@"
{
""baz"": ""qux"",
""foo"": ""bar""
}
    ");

    using var patch = JsonDocument.Parse(@"
[
{ ""op"": ""replace"", ""path"": ""/baz"", ""value"": ""boo"" },
{ ""op"": ""add"", ""path"": ""/hello"", ""value"": [""world""] },
{ ""op"": ""remove"", ""path"": ""/foo"" }
]
    ");

    using JsonDocument result = JsonPatch.ApplyPatch(doc.RootElement, patch.RootElement);

    var options = new JsonSerializerOptions() { WriteIndented = true };

    Console.WriteLine("The original document:\n");
    Console.WriteLine($"{JsonSerializer.Serialize(doc, options)}\n");
    Console.WriteLine("The patch:\n");
    Console.WriteLine($"{JsonSerializer.Serialize(patch, options)}\n");
    Console.WriteLine("The result:\n");
    Console.WriteLine($"{JsonSerializer.Serialize(result, options)}\n");
       ");
    }
}

The original document:

{
  "baz": "qux",
  "foo": "bar"
}

The patch:

[
  {
    "op": "replace",
    "path": "/baz",
    "value": "boo"
  },
  {
    "op": "add",
    "path": "/hello",
    "value": [
      "world"
    ]
  },
  {
    "op": "remove",
    "path": "/foo"
  }
]

The result:

{
  "baz": "boo",
  "hello": [
    "world"
  ]
}

Methods

| Improve this Doc View Source

ApplyPatch(JsonElement, JsonElement)

Applies a JSON Patch as defined in RFC 6902 to a source JSON value.

Declaration

public static JsonDocument ApplyPatch(JsonElement source, JsonElement patch)

Parameters

Type	Name	Description
System.Text.Json.JsonElement	source	The source JSON value.
System.Text.Json.JsonElement	patch	The patch to be applied to the source JSON value.

Returns

Type	Description
System.Text.Json.JsonDocument	The patched JSON value

Remarks

It is the users responsibilty to properly Dispose the returned System.Text.Json.JsonDocument value

Exceptions

Type	Condition
System.ArgumentException	The provided `patch` is invalid
JsonPatchException	A JSON Patch operation failed