JSONBuddyLibrary is a C# .NET wrapper for the jsonvalidator.dll, a powerful x64 native library for validating, formatting JSON text, JSON data patching, and JSON Schema documentation.
This package provides a simple and efficient way to leverage advanced JSON validation capabilities in your .NET applications.
JSONBuddyLibrary is a .NET wrapper for the jsonvalidator.dll, a powerful native library for validating, minifying, and prettifying JSON data. This package provides a simple and efficient way to leverage advanced JSON validation capabilities in your .NET applications, including streaming schema validation for huge data and customizable validation processes with callbacks.
Features
JSON Validation: Validate JSON documents against various JSON Schema drafts.
Generate JSON Schema documentation: Create HTML/SVG documentation from your JSON Schemas.
Minification and Prettification: Easily minify or prettify JSON strings.
JSON Patch: Apply JSON Patch operations to JSON documents.
Schema Support: Supports multiple JSON Schema drafts, including Draft04, Draft06, Draft07, Draft201909, and Draft202012.
Custom Callbacks: Define custom callbacks for document loading and validation reporting.
License Support: Unlock enhanced functionality with a valid license key. You can obtain a full license from here JSONBuddy Online Shop.
Free versus full version
The following functionality is available in the free version:
JSON Schema validation supporting all schema drafts.
Prettify and minify JSON text.
The full version includes the following additional features:
Streaming JSON data validation.
JSON Schema documentation generation.
Applying JSONPatch operations.
Installation
You can install the JSONBuddyLibrary package using any of the following methods:
NuGet Package Manager
PM> Install-Package JSONBuddyLibrary
.NET CLI
dotnet add package JSONBuddyLibrary
PackageReference
Add the following XML node into your project file to reference the package:
You can define custom callbacks for loading documents and handling validation results. Please find below an example of how to use the streaming validation functionality with custom callbacks:
using System;
using System.Runtime.InteropServices;
using JSONBuddyLibrary;
class Program
{
static void Main()
{
IntPtr validator = JSONValidatorWrapper.JB_NewJSONSchemaValidator("", "");
// Define a document loader callback
JSONValidatorWrapper.LoadDocumentCallback documentLoader = (string path, out IntPtr content, out IntPtr error, long maxFileSize) =>
{
content = IntPtr.Zero;
error = IntPtr.Zero;
// Load your external document here, convert it to UTF-16LE, and assign it to content
// For simplicity, we'll just return false here
return false;
};
// Define a results entry added callback
JSONValidatorWrapper.ResultsEntryAddedCallback resultsCallback = (string jsonPointer, string jsonPointerSchema, string schemaKey, string pathToSchema, bool isValid, long validationStep, string message) =>
{
Console.WriteLine($"Validation Error: {message}");
return true; // Continue validation
};
string jsonInstancePath = "path_to_json_file.json";
bool validationSuccess = JSONValidatorWrapper.JB_ValidateJSONDocumentStream(validator, jsonInstancePath, documentLoader, resultsCallback, null);
Console.WriteLine($"Validation Success: {validationSuccess}");
JSONValidatorWrapper.JB_FreeJSONSchemaValidator(validator);
}
}
Supported Schema Drafts
The following JSON Schema drafts are supported:
Draft04 (0)
Draft06 (1)
Draft07 (2)
Draft201909 (3)
Draft202012 (4)
Requirements
Platform: Windows (x64)
.NET Standard 2.0 or higher
Changelog
Version 1.1.2
Added support for JSON Schema documentation and JSONPatch operations.
Version 1.0.0
Initial release with standard and streaming JSON validation, minification, and prettification functionalities.
License
The JSONBuddyLibrary wrapper included in this NuGet package is free to use under the MIT license,
allowing developers to easily integrate standard JSON validation and manipulation capabilities into their .NET applications.
However, the underlying jsonvalidator.dll included in the package contains advanced functionality
that requires a commercial license for full access. Users can utilize basic features without a license, but to unlock enhanced capabilities,
a valid license key must be provided. For more details on the licensing terms, please refer to the license.txt file included in this package.