JsonSchema.Net 7.1.1

There is a newer version of this package available.
See the version list below for details.

Requires NuGet 2.12 or higher.

dotnet add package JsonSchema.Net --version 7.1.1                
NuGet\Install-Package JsonSchema.Net -Version 7.1.1                
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="JsonSchema.Net" Version="7.1.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add JsonSchema.Net --version 7.1.1                
#r "nuget: JsonSchema.Net, 7.1.1"                
#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.
// Install JsonSchema.Net as a Cake Addin
#addin nuget:?package=JsonSchema.Net&version=7.1.1

// Install JsonSchema.Net as a Cake Tool
#tool nuget:?package=JsonSchema.Net&version=7.1.1                

Summary

JsonSchema.Net fully implements the JSON Schema specifications, a declarative syntax for validation and annotating JSON data.

Supported specifications:

  • Draft 6 - http://json-schema.org/draft-06/schema#
  • Draft 7 - http://json-schema.org/draft-07/schema#
  • Draft 2019-09 - https://json-schema.org/draft/2019-09/schema
  • Draft 2020-12 - https://json-schema.org/draft/2020-12/schema

This project also operates as a test bed for features proposed for the next version ("draft/next").

Usage

Parse a schema:

var schema = JsonSchema.FromText(content);

Load one from a file:

var schema = JsonSchema.FromFile(filename);

Directly deserialize it:

var schema = JsonSerializer.Deserialize<JsonSchema>(content);

Or build it explicitly in code:

var schema = new JsonSchemaBuilder()
    .Comment("a comment")
    .Title("A title for my schema")
    .Type(SchemaValueType.Object)
    .Properties(
        ("foo", new JsonSchemaBuilder()
            .Type(SchemaValueType.String)
        ),
        ("bar", new JsonSchemaBuilder()
            .Type(SchemaValueType.Number)
        )
    )
    .Build();

Use the schema to evaluate and annotate data:

var instance = JsonNode.Parse("{\"foo\":\"a value\",\"bar\":42}");
var results = schema.Evaluate(instance);

Sponsorship

If you found this library helpful and would like to promote continued development, please consider sponsoring the maintainers.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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 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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (69)

Showing the top 5 NuGet packages that depend on JsonSchema.Net:

Package Downloads
Microsoft.PowerShell.Commands.Utility

Runtime for hosting PowerShell

JsonSchema.Net.Generation

Extends JsonSchema.Net to provide schema generation functionality

CycloneDX.Core

A .NET Standard library for CycloneDX bill-of-material documents.

Qart.Testing

Package Description

com.etsoo.CoreFramework

ETSOO Shared Core Framework 亿速思维共享核心框架

GitHub repositories (14)

Showing the top 5 popular GitHub repositories that depend on JsonSchema.Net:

Repository Stars
PowerShell/PowerShell
PowerShell for every system!
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
dotnet/runtime
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
dotnet/docfx
Static site generator for .NET API documentation.
dotnet/aspire
An opinionated, cloud ready stack for building observable, production ready, distributed applications in .NET
Version Downloads Last updated
7.2.3 8,120 9/20/2024
7.2.2 75,546 8/18/2024
7.2.1 1,555 8/16/2024
7.2.0 38,470 8/7/2024
7.1.2 147,745 7/2/2024
7.1.1 19,943 6/28/2024
7.1.0 13,369 6/25/2024
7.0.4 102,027 6/8/2024
7.0.3 21,343 6/3/2024
7.0.2 81,837 5/13/2024
7.0.1 23,840 5/7/2024
7.0.0.3 29,986 5/1/2024
6.1.2 58,521 4/22/2024
6.1.1 6,173 4/20/2024 6.1.1 is deprecated because it has critical bugs.
6.1.0.1 70,603 4/19/2024 6.1.0.1 is deprecated because it has critical bugs.
6.1.0 20,169 4/18/2024 6.1.0 is deprecated because it has critical bugs.
6.0.7 82,900 3/25/2024
6.0.6 2,472 3/24/2024
6.0.5 70,261 3/18/2024
6.0.4 64,547 3/3/2024
6.0.3 154,621 2/19/2024
6.0.2 24,241 2/7/2024
6.0.1 14,412 2/3/2024
6.0.0 49,579 2/3/2024
5.5.1 177,459 1/21/2024
5.5.0 123,342 1/8/2024
5.4.3 70,350 12/19/2023
5.4.2 777,318 12/5/2023
5.4.1 7,539 12/2/2023
5.4.0 77,284 11/21/2023
5.3.1 335,725 11/4/2023
5.3.0 15,787 10/30/2023
5.2.7 833,062 10/28/2023
5.2.6 206,918 10/1/2023
5.2.5 64,954 9/10/2023
5.2.4 749 9/10/2023
5.2.3 3,352 9/8/2023
5.2.2 409 9/7/2023
5.2.1 28,631 9/1/2023
5.2.0 27,444 8/22/2023
5.1.3 65,817 8/5/2023
5.1.0 2,174 8/4/2023
5.0.0 1,495 8/2/2023
4.1.8 120,279 7/21/2023
4.1.7 2,891 7/20/2023
4.1.6 218,276 7/3/2023
4.1.5 799,446 6/13/2023
4.1.4 390 6/13/2023
4.1.3 2,307 6/10/2023
4.1.2 6,657 6/7/2023
4.1.1 207,041 5/5/2023
4.1.0 41,578 4/30/2023
4.0.7 1,010 4/28/2023
4.0.6 16,598 4/23/2023
4.0.5 5,687 4/20/2023
4.0.4 41,942 4/19/2023
4.0.3 92,041 4/5/2023
4.0.2 19,449 3/29/2023
4.0.1 8,644 3/27/2023
4.0.0 78,547 3/19/2023
4.0.0-beta3 5,411 2/28/2023
4.0.0-beta2 7,959 12/14/2022
4.0.0-beta1a 652 12/1/2022
3.3.2 866,612 11/13/2022
3.3.1 2,097 11/11/2022
3.3.0 34,727 11/6/2022
3.2.1 227,873 9/4/2022
3.2.0 375,599 7/11/2022
3.1.5 4,758 7/11/2022
3.1.4 9,861 7/5/2022
3.1.3 509 7/5/2022
3.1.2 12,829 6/28/2022
3.1.1 19,288 6/16/2022
3.1.0 3,589 6/15/2022
3.0.0 7,339 6/13/2022
2.4.0 109,177 5/26/2022
2.3.0 96,082 4/4/2022
2.2.1 18,720 3/31/2022
2.2.0 45,409 3/24/2022
2.1.2 18,708 3/22/2022
2.1.1 20,621 2/25/2022
2.1.0 5,577 2/23/2022
2.0.3 12,335 2/12/2022
2.0.2 13,158 2/9/2022
2.0.1 50,370 1/28/2022
2.0.0 58,512 1/13/2022
1.13.0 18,303 1/12/2022
1.12.0 49,639 12/5/2021
1.11.6 16,058 11/29/2021
1.11.5 36,726 11/11/2021
1.11.4 6,267 11/5/2021
1.11.3 129,863 9/22/2021
1.11.2 85,391 9/5/2021
1.11.1 478 9/5/2021
1.11.0 460 9/4/2021
1.10.8 15,633 8/27/2021
1.10.7 126,700 7/13/2021
1.10.6 16,533 7/2/2021
1.10.5 1,799 6/29/2021
1.10.4 20,871 6/20/2021
1.10.3 29,983 6/5/2021
1.10.2 42,527 4/17/2021
1.10.1 942 4/14/2021
1.10.0 1,727 4/10/2021
1.9.4 5,809 4/3/2021
1.9.3 30,822 3/5/2021
1.9.2 513 3/3/2021
1.9.1 23,596 2/24/2021
1.9.0 883 2/24/2021
1.8.0 7,606 2/3/2021
1.7.1 5,297 1/21/2021
1.7.0 1,824 1/17/2021
1.6.1 2,814 1/1/2021
1.6.0 7,567 12/14/2020
1.5.4 5,327 11/28/2020
1.5.3 2,413 11/26/2020
1.5.2 905 11/22/2020
1.5.1 2,044 11/3/2020
1.5.0 647 11/1/2020
1.4.0 553 10/30/2020
1.3.1 618 10/22/2020
1.3.0 972 10/17/2020
1.2.0 2,230 10/9/2020
1.1.0 744 10/5/2020
1.0.3 563 9/29/2020
1.0.2 1,775 9/1/2020
1.0.1 596 9/1/2020
1.0.0 3,828 8/29/2020
1.0.0-rc2 385 8/29/2020
1.0.0-rc1 348 8/28/2020

Release notes can be found at https://json-everything.net/json-schema