Philiprehberger.JsonPatch 0.2.1

Philiprehberger.JsonPatch

RFC 6902 JSON Patch operations for System.Text.Json — apply, generate, and parse patch documents.

Installation

dotnet add package Philiprehberger.JsonPatch

Usage

using System.Text.Json.Nodes;
using Philiprehberger.JsonPatch;

var document = JsonNode.Parse("""{"name": "Alice", "age": 30}""");

var operations = new[]
{
    PatchOperation.Replace("/name", JsonValue.Create("Bob")),
    PatchOperation.Add("/email", JsonValue.Create("bob@example.com")),
    PatchOperation.Remove("/age")
};

var result = JsonPatch.Apply(document, operations);
// {"name":"Bob","email":"bob@example.com"}

Generate a Diff

using System.Text.Json.Nodes;
using Philiprehberger.JsonPatch;

var before = JsonNode.Parse("""{"name": "Alice", "age": 30}""");
var after = JsonNode.Parse("""{"name": "Alice", "age": 31, "email": "alice@example.com"}""");

var operations = JsonPatch.Diff(before, after);

foreach (var op in operations)
    Console.WriteLine($"{op.Op} {op.Path}");
// replace /age
// add /email

Parse from JSON

using Philiprehberger.JsonPatch;

var json = """
[
  { "op": "replace", "path": "/name", "value": "Bob" },
  { "op": "remove", "path": "/age" }
]
""";

var patchDoc = JsonPatch.Parse(json);
var result = patchDoc.Apply(JsonNode.Parse("""{"name": "Alice", "age": 30}"""));
// {"name":"Bob"}

Reverse Patch Generation

using System.Text.Json.Nodes;
using Philiprehberger.JsonPatch;

var original = JsonNode.Parse("""{"name": "Alice", "age": 30}""");
var patch = new JsonPatchDocument(new[]
{
    PatchOperation.Replace("/name", JsonValue.Create("Bob")),
    PatchOperation.Remove("/age")
});

var patched = patch.Apply(original);
var reverse = JsonPatch.GenerateReverse(patch, JsonNode.Parse("""{"name": "Alice", "age": 30}"""));
var restored = reverse.Apply(patched);
// restored = {"name":"Alice","age":30}

Patch Validation

using System.Text.Json.Nodes;
using Philiprehberger.JsonPatch;

var document = JsonNode.Parse("""{"name": "Alice"}""");
var patch = new JsonPatchDocument(new[]
{
    PatchOperation.Remove("/nonexistent")
});

var result = JsonPatch.Validate(patch, document);
// result.IsValid == false
// result.Errors[0].Message contains "does not exist"

Patch Composition

using System.Text.Json.Nodes;
using Philiprehberger.JsonPatch;

var first = new JsonPatchDocument(new[]
{
    PatchOperation.Replace("/name", JsonValue.Create("Bob"))
});
var second = new JsonPatchDocument(new[]
{
    PatchOperation.Add("/email", JsonValue.Create("bob@example.com"))
});

var composed = JsonPatch.Compose(first, second);
var result = composed.Apply(JsonNode.Parse("""{"name": "Alice"}"""));
// {"name":"Bob","email":"bob@example.com"}

Partial Application

using System.Text.Json.Nodes;
using Philiprehberger.JsonPatch;

var document = JsonNode.Parse("""{"name": "Alice"}""");
var patch = new JsonPatchDocument(new[]
{
    PatchOperation.Replace("/name", JsonValue.Create("Bob")),
    PatchOperation.Remove("/nonexistent"),
    PatchOperation.Add("/age", JsonValue.Create(30))
});

var result = JsonPatch.ApplyPartial(patch, document);
// result.IsFullyApplied == false
// result.Applied.Count == 2
// result.Failures.Count == 1
// result.Document = {"name":"Bob","age":30}

API

JsonPatch

JsonPatchDocument

PatchOperation

ValidationResult

ValidationError

PartialApplicationResult

OperationFailure

Development

dotnet build src/Philiprehberger.JsonPatch.csproj --configuration Release

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT