Microsoft.AspNetCore.JsonPatch 10.0.0-preview.5.25277.114

About

Microsoft.AspNetCore.JsonPatch provides ASP.NET Core support for JSON PATCH requests.

How to Use

To use Microsoft.AspNetCore.JsonPatch, follow these steps:

Installation

dotnet add package Microsoft.AspNetCore.JsonPatch
dotnet add package Microsoft.AspNetCore.Mvc.NewtonsoftJson

Configuration

To enable JSON Patch support, call AddNewtonsoftJson in your ASP.NET Core app's Program.cs:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers()
    .AddNewtonsoftJson();

Configure when using System.Text.Json

To add support for JSON Patch using Newtonsoft.Json while continuing to use System.Text.Json for other input and output formatters:

  1. Update your Program.cs with logic to construct a NewtonsoftJsonPatchInputFormatter:
    static NewtonsoftJsonPatchInputFormatter GetJsonPatchInputFormatter()
    {
        var builder = new ServiceCollection()
            .AddLogging()
            .AddMvc()
            .AddNewtonsoftJson()
            .Services.BuildServiceProvider();
    
        return builder
            .GetRequiredService<IOptions<MvcOptions>>()
            .Value
            .InputFormatters
            .OfType<NewtonsoftJsonPatchInputFormatter>()
            .First();
    }
    
  2. Configure the input formatter:
    var builder = WebApplication.CreateBuilder(args);
    
    builder.Services.AddControllers(options =>
    {
        options.InputFormatters.Insert(0, GetJsonPatchInputFormatter());
    });
    

Usage

To define an action method for a JSON Patch in an API controller:

  1. Annotate it with the HttpPatch attribute
  2. Accept a JsonPatchDocument<TModel>
  3. Call ApplyTo on the patch document to apply changes

For example:

[HttpPatch]
public IActionResult JsonPatchWithModelState(
    [FromBody] JsonPatchDocument<Customer> patchDoc)
{
    if (patchDoc is not null)
    {
        var customer = CreateCustomer();

        patchDoc.ApplyTo(customer, ModelState);

        if (!ModelState.IsValid)
        {
            return BadRequest(ModelState);
        }

        return new ObjectResult(customer);
    }
    else
    {
        return BadRequest(ModelState);
    }
}

In a real app, the code would retrieve the data from a store such as a database and update the database after applying the patch.

Additional Documentation

For additional documentation and examples, refer to the official documentation on JSON Patch in ASP.NET Core.

Feedback & Contributing

Microsoft.AspNetCore.JsonPatch is released as open-source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Showing the top 20 packages that depend on Microsoft.AspNetCore.JsonPatch.

Packages Downloads
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
10
KubernetesClient
Client library for the Kubernetes open source container orchestrator.
11
Microsoft.AspNetCore.All
Microsoft.AspNetCore.All
10
Microsoft.AspNetCore.All
Provides a default set of APIs for building an ASP.NET Core application, and also includes API for third-party integrations with ASP.NET Core. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
10
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
12
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET. This package was built from the source code at https://github.com/aspnet/Mvc/tree/a6199bbfbab05583f987bae322fb04566841aaea
507
Microsoft.AspNetCore.Mvc.NewtonsoftJson
ASP.NET Core MVC features that use Newtonsoft.Json. Includes input and output formatters for JSON and JSON PATCH. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/1bf292d47ac2a0ebda07d8a3f00355dd01915ad5
10
Microsoft.AspNetCore.Mvc.NewtonsoftJson
ASP.NET Core MVC features that use Newtonsoft.Json. Includes input and output formatters for JSON and JSON PATCH. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/5502cf46706a25c39ce78a57b9191714c0eb40c2
9
Microsoft.AspNetCore.Mvc.NewtonsoftJson
ASP.NET Core MVC features that use Newtonsoft.Json. Includes input and output formatters for JSON and JSON PATCH. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/844a82e37cae48af2ab2ee4f39b41283e6bb4f0e
11
Microsoft.AspNetCore.Mvc.NewtonsoftJson
ASP.NET Core MVC features that use Newtonsoft.Json. Includes input and output formatters for JSON and JSON PATCH. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/8ca3954ca335343ce6dd1d14d8d1c6c3369710b7
10
Microsoft.AspNetCore.Mvc.NewtonsoftJson
ASP.NET Core MVC features that use Newtonsoft.Json. Includes input and output formatters for JSON and JSON PATCH. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/4e7d976438b0fc17f435804e801d5d68d193ec33
11
Microsoft.AspNetCore.Mvc.NewtonsoftJson
ASP.NET Core MVC features that use Newtonsoft.Json. Includes input and output formatters for JSON and JSON PATCH. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/bb01bbf4433e27289b99001b7de6a582879d1835
11
Microsoft.AspNetCore.Mvc.NewtonsoftJson
ASP.NET Core MVC features that use Newtonsoft.Json. Includes input and output formatters for JSON and JSON PATCH. This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/f9ae0f5d30be2de3c0de61b5673bd8873231d70a
10

.NET Framework 4.6.2

.NET 10.0

.NET Standard 2.0

Version Downloads Last updated
10.0.0-preview.5.25277.114 2 06/07/2025
10.0.0-preview.4.25258.110 1 05/18/2025
10.0.0-preview.3.25172.1 2 04/19/2025
10.0.0-preview.2.25164.1 2 03/29/2025
10.0.0-preview.1.25120.3 3 02/26/2025
9.0.6 1 06/13/2025
9.0.5 2 06/12/2025
9.0.4 3 05/10/2025
9.0.3 3 03/29/2025
9.0.2 4 02/21/2025
9.0.1 4 01/19/2025
9.0.0 4 01/19/2025
9.0.0-rc.2.24474.3 4 01/02/2025
9.0.0-rc.1.24452.1 4 12/15/2024
9.0.0-preview.7.24406.2 4 01/19/2025
9.0.0-preview.6.24328.4 3 01/19/2025
9.0.0-preview.5.24306.11 5 01/04/2025
9.0.0-preview.4.24267.6 3 01/31/2025
9.0.0-preview.3.24172.13 3 01/19/2025
9.0.0-preview.2.24128.4 6 03/26/2024
9.0.0-preview.1.24081.5 6 03/08/2024
8.0.17 1 06/13/2025
8.0.16 0 05/13/2025
8.0.15 1 04/19/2025
8.0.14 2 03/29/2025
8.0.13 3 02/21/2025
8.0.12 3 01/19/2025
8.0.11 3 01/19/2025
8.0.10 3 12/14/2024
8.0.8 4 01/19/2025
8.0.7 4 12/27/2024
8.0.6 3 01/31/2025
8.0.5 4 01/19/2025
8.0.4 4 01/19/2025
8.0.3 7 03/26/2024
8.0.2 7 03/01/2024
8.0.1 9 03/01/2024
8.0.0 7 03/04/2024
8.0.0-rc.2.23480.2 7 11/13/2023
8.0.0-rc.1.23421.29 6 03/04/2024
8.0.0-preview.7.23375.9 5 11/17/2023
8.0.0-preview.6.23329.11 6 11/16/2023
8.0.0-preview.5.23302.2 6 03/04/2024
8.0.0-preview.4.23260.4 5 03/09/2024
8.0.0-preview.3.23177.8 6 03/09/2024
8.0.0-preview.2.23153.2 7 03/03/2024
8.0.0-preview.1.23112.2 5 11/18/2023
7.0.20 7 12/26/2024
7.0.19 3 01/16/2025
7.0.18 3 01/19/2025
7.0.17 6 03/27/2024
7.0.16 4 02/29/2024
7.0.15 6 03/04/2024
7.0.14 8 02/07/2024
7.0.13 6 01/04/2024
7.0.12 6 03/01/2024
7.0.11 6 03/01/2024
7.0.10 5 03/03/2024
7.0.9 6 11/18/2023
7.0.8 7 03/03/2024
7.0.7 6 11/19/2023
7.0.5 6 03/04/2024
7.0.4 7 03/04/2024
7.0.3 8 03/04/2024
7.0.2 7 03/04/2024
7.0.1 7 03/04/2024
7.0.0 8 10/17/2023
7.0.0-rc.2.22476.2 6 03/02/2024
7.0.0-rc.1.22427.2 5 03/13/2024
7.0.0-preview.7.22376.6 5 03/09/2024
7.0.0-preview.6.22330.3 6 11/15/2023
7.0.0-preview.5.22303.8 6 03/09/2024
7.0.0-preview.4.22251.1 6 03/03/2024
7.0.0-preview.3.22178.4 5 03/09/2024
7.0.0-preview.2.22153.2 6 03/08/2024
7.0.0-preview.1.22109.13 6 11/17/2023
6.0.36 3 01/19/2025
6.0.35 3 01/14/2025
6.0.33 4 12/25/2024
6.0.32 3 12/28/2024
6.0.31 4 12/17/2024
6.0.30 3 11/30/2024
6.0.29 2 01/19/2025
6.0.28 5 03/26/2024
6.0.27 6 03/01/2024
6.0.26 5 03/12/2024
6.0.25 5 03/09/2024
6.0.24 6 03/02/2024
6.0.23 6 11/19/2023
6.0.22 5 03/03/2024
6.0.21 10 03/02/2024
6.0.20 6 03/04/2024
6.0.19 5 11/20/2023
6.0.18 6 02/08/2024
6.0.16 6 10/17/2023
6.0.15 4 03/12/2024
6.0.14 6 03/03/2024
6.0.13 6 03/04/2024
6.0.12 8 08/22/2023
6.0.11 5 11/14/2023
6.0.10 6 03/03/2024
6.0.9 8 03/04/2024
6.0.8 9 03/04/2024
6.0.7 7 11/21/2023
6.0.6 7 03/05/2024
6.0.5 7 03/04/2024
6.0.4 5 11/20/2023
6.0.3 7 03/04/2024
6.0.2 7 01/08/2024
6.0.1 11 08/18/2023
6.0.0 7 03/03/2024
6.0.0-rc.2.21480.10 8 11/19/2023
6.0.0-rc.1.21452.15 6 11/19/2023
6.0.0-preview.7.21378.6 7 03/09/2024
6.0.0-preview.6.21355.2 5 03/09/2024
6.0.0-preview.5.21301.17 5 03/09/2024
6.0.0-preview.4.21253.5 6 11/19/2023
6.0.0-preview.3.21201.13 6 11/18/2023
6.0.0-preview.2.21154.6 5 03/09/2024
6.0.0-preview.1.21103.6 7 03/05/2024
5.0.17 5 03/06/2024
5.0.16 7 11/16/2023
5.0.15 6 03/27/2024
5.0.14 6 11/18/2023
5.0.13 7 03/03/2024
5.0.12 5 03/04/2024
5.0.11 5 11/19/2023
5.0.10 4 03/12/2024
5.0.9 7 11/19/2023
5.0.8 8 03/06/2024
5.0.7 6 03/06/2024
5.0.6 8 03/06/2024
5.0.5 7 03/05/2024
5.0.4 8 03/17/2024
5.0.3 8 03/01/2024
5.0.2 9 11/16/2023
5.0.1 7 03/04/2024
5.0.0 8 03/04/2024
5.0.0-rc.2.20475.17 5 03/02/2024
5.0.0-rc.1.20451.17 5 03/16/2024
5.0.0-preview.8.20414.8 5 11/17/2023
5.0.0-preview.7.20365.19 6 03/09/2024
5.0.0-preview.6.20312.15 5 03/09/2024
5.0.0-preview.5.20279.2 5 03/02/2024
5.0.0-preview.4.20257.10 5 03/09/2024
5.0.0-preview.3.20215.14 6 03/09/2024
5.0.0-preview.2.20167.3 5 03/09/2024
5.0.0-preview.1.20124.5 5 02/28/2024
3.1.32 5 03/12/2024
3.1.31 6 03/12/2024
3.1.30 6 03/03/2024
3.1.29 5 03/04/2024
3.1.28 6 11/15/2023
3.1.27 6 03/25/2024
3.1.26 6 03/06/2024
3.1.25 6 11/21/2023
3.1.24 6 03/05/2024
3.1.23 6 03/05/2024
3.1.22 5 03/12/2024
3.1.21 5 03/03/2024
3.1.20 5 03/12/2024
3.1.19 8 03/03/2024
3.1.18 6 11/15/2023
3.1.17 4 03/12/2024
3.1.16 6 11/19/2023
3.1.15 10 08/18/2023
3.1.14 5 03/12/2024
3.1.13 6 03/04/2024
3.1.12 6 03/04/2024
3.1.11 7 11/16/2023
3.1.10 6 11/20/2023
3.1.9 7 01/18/2024
3.1.8 7 03/03/2024
3.1.7 9 11/18/2023
3.1.6 7 11/23/2023
3.1.5 7 03/03/2024
3.1.4 6 03/04/2024
3.1.3 6 11/20/2023
3.1.2 8 03/04/2024
3.1.1 7 11/21/2023
3.1.0 7 03/01/2024
3.1.0-preview3.19555.2 8 03/09/2024
3.1.0-preview2.19528.8 7 03/08/2024
3.1.0-preview1.19508.20 6 11/19/2023
3.0.3 8 11/19/2023
3.0.2 6 03/04/2024
3.0.0 6 11/18/2023
3.0.0-rc1.19457.4 5 03/09/2024
3.0.0-preview9.19424.4 5 03/09/2024
3.0.0-preview8.19405.7 6 03/09/2024
3.0.0-preview7.19365.7 5 11/16/2023
3.0.0-preview6.19307.2 5 03/02/2024
3.0.0-preview5-19227-01 11 08/18/2023
3.0.0-preview4-19216-03 6 03/10/2024
3.0.0-preview3-19153-02 9 08/18/2023
3.0.0-preview-19075-0444 8 03/10/2024
3.0.0-preview-18579-0056 7 11/15/2023
2.3.0 4 01/19/2025
2.2.0 500 08/18/2023
2.2.0-preview3-35497 3 01/19/2025
2.2.0-preview2-35157 5 03/09/2024
2.2.0-preview1-35029 6 03/09/2024
2.1.1 7 03/12/2024
2.1.0 7 11/16/2023
2.1.0-rc1-final 6 03/03/2024
2.1.0-preview2-final 6 11/18/2023
2.1.0-preview1-final 6 03/06/2024
2.0.0 10 11/28/2023
2.0.0-preview2-final 7 11/15/2023
2.0.0-preview1-final 5 03/01/2024
1.1.2 7 11/16/2023
1.1.1 6 03/04/2024
1.1.0 7 03/04/2024
1.1.0-preview1-final 7 03/09/2024
1.0.0 8 03/03/2024
1.0.0-rc2-final 5 03/13/2024