JsonScrutinize 1.0.3

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package JsonScrutinize --version 1.0.3
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="JsonScrutinize" />
                    


                            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 JsonScrutinize --version 1.0.3
                    


                    

                
#r "nuget: JsonScrutinize, 1.0.3"
#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. 
#addin nuget:?package=JsonScrutinize&version=1.0.3
                    


                            Install JsonScrutinize as a Cake Addin
                        

                    

                
#tool nuget:?package=JsonScrutinize&version=1.0.3
                    


                            Install JsonScrutinize as a Cake Tool

A library created to sanitize JSON strings where a standard class is available for comparison.

Each function will recursively search for intended keys (Mismatched typs, Null keys or missing Keys) from the JSON string which differ from the standard ones.

Standard classes can be defined with [Required] tag to make keys required, [RegularExpression(<pattern>)] to add a specific regex to the key, MisMatched type will compare the regex pattern and allow if the regex matches.

Example:

TypeToCompare ( System.Type variable) can be generated from by doing .getType() to a regular Class in c#.

Let the below class be the standard class to compare with the JSON string.

public class StandardClass
{
	[Required]
	public string key1 { get; set; }
	[RegularExpression(@"^[0-9]{3}$")]
	public string key2 { get; set; }
	public string key3 { get; set; }
}

The JSON string to be sanitized is as follows:

{
	"key1": "value1",
	"key2": "123",
	"key3" : 123
}

Above JSON has key3 of incorrect type, which is an integer, but the standard class has key3 as a string.

To check which key is incorrect, the below code can be used:

StandardClass standard = new StandardClass();
string json = "{\"key1\": \"value1\",\"key2\": \"123\",\"key3 : 123}";
Type typeToCheck = standard.GetType();
List<string> result = await JSONScrutinize.JSONScrutinize.SanitizeJSON(json, typeToCheck);

The result will be a list of strings containing the keys which are incorrect, in this case, key3.

Output is be :

[
	"key3"
]
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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. 
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
2.0.1 103 2/4/2025
2.0.0 83 2/4/2025
1.0.4 96 2/3/2025
1.0.3 95 2/3/2025
1.0.2 82 2/3/2025
1.0.1 101 2/3/2025
1.0.0 98 2/3/2025