JsonPathSerializer 0.1.0-alpha

.NET 7.0 This package targets .NET 7.0. The package is compatible with this framework or higher.
This is a prerelease version of JsonPathSerializer.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package JsonPathSerializer --version 0.1.0-alpha
                    


                    

                
NuGet\Install-Package JsonPathSerializer -Version 0.1.0-alpha
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="JsonPathSerializer" Version="0.1.0-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="JsonPathSerializer" Version="0.1.0-alpha" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="JsonPathSerializer" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add JsonPathSerializer --version 0.1.0-alpha
                    


                    

                
#r "nuget: JsonPathSerializer, 0.1.0-alpha"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package JsonPathSerializer@0.1.0-alpha
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=JsonPathSerializer&version=0.1.0-alpha&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=JsonPathSerializer&version=0.1.0-alpha&prerelease
                    


                            Install as a Cake Tool

JsonPathSerializer

Class library that helps putting data into the right place in a Json string, using JsonPath

Description

Built with .NET and newtonsoft.Json, JsonPathSerializer is a class library that aims to help automated tests and simulations to build large JSON objects using only values and their respective JSON path.

As of version 0.0.1.0, the project is more of a concept demo rather than a complete, deliverable .NET class library. See Constaints about known limitations of JsonPathSerializer.

Quick-demo

After building the project, reference the class library in your program and import it as using JsonPathSerializer;. You will also need the nuget Newtonsoft.Json.

Then, try the following code:

Dictionary<string, string> pathToValue = new Dictionary<string, string>()
{
    { "$.say.hello.world", "Hello world!" },
    { "$.say.hello.john", "Hello John!" },
    { "$.say.hi.jane", "Hi jane!" },
    { "$.say.hi.montreal[0]", "Salut Montr�al!" },
    { "$.say.hi.montreal[1]", "Hi Montreal!" },
};

JsonPathManager manager = new JsonPathManager();
foreach (var pair in pathToValue)
{
    manager.Add(pair.Key, pair.Value);
}
Console.WriteLine(manager.Build());

Which gives: {"say":{"hello":{"world":"Hello world!","john":"Hello John!"},"hi":{"jane":"Hi jane!","montreal":["Salut Montr�al!","Hi Montreal!"]}}}, or:

{
  "say": {
    "hello": {
      "world": "Hello world!",
      "john": "Hello John!"
    },
    "hi": {
      "jane": "Hi jane!",
      "montreal": [
        "Salut Montr�al!",
        "Hi Montreal!"
      ]
    }
  }
}

Feature Summary

JsonPathSerializer supports JSON path in both dot and bracket notation, and currently support the following JSON path operation:

  • Property, e.g. $.foo.key or ['foo']['key']
  • Index, e.g. $.foo[1], $[-2]
  • Multiple indexes, e.g. $.foo[1,2], $[-2, 3, 1]

JsonPathManager instance can be initialized with no argument (will create a new empty root), or with a JObject or JArray as its root.

Constaints

There are several important known issues and limitations for JsonPathSerializer for future development:

  • Supports for JSON path operators will be gradually implemented.
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.0.0 172 5/30/2024
0.3.0 185 1/29/2024
0.2.0 207 11/13/2023
0.1.2 133 9/26/2023
0.1.0-beta 198 12/31/2022
0.1.0-alpha 188 12/31/2022