Microsoft.AspNetCore.JsonPatch 10.0.0-preview.6.25358.103

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
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
109
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
98
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
93
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
92
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 at: https://github.com/aspnet/Mvc/tree/522006d2c866add522a546aa3b4720577f1cee57
92
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 at: https://github.com/aspnet/Mvc/tree/b9793f0a1d9a75940c50e31e956d09397a5d1876
90
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
89
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
88
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
87
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
86
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
84
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
83
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
82
Microsoft.AspNetCore.Mvc.Formatters.Json
ASP.NET Core MVC formatters for JSON input and output and for JSON PATCH input using Json.NET.
81

.NET Framework 4.6.2

.NET 10.0

.NET Standard 2.0

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