Skip to content

Latest commit

 

History

History
296 lines (213 loc) · 15.5 KB

implementations.md

File metadata and controls

296 lines (213 loc) · 15.5 KB
Raw
layout title permalink
page
Implementations
/implementations.html

NOTE: This page lists implementations with (or actively working towards) support for draft-06 or later.

For implementations supporting only draft-04 or older, see the Obsolete Implementations page.

  • TOC {:toc}

Implementations below are written in different languages, and support part, or all, of at least one recent version of the specification.

Implementations are classified based on their functionality. When known, the license of the project is also mentioned.

If you have updates to this list, make a pull request on the GitHub repo.

Validators

{% assign validator-libraries = site.data.validator-libraries-modern %}

{% for language in validator-libraries %}

  • [{{ language.name }}](#validator-{% if language.anchor-name %}{{ language.anchor-name }}{% else %}{{ language.name | downcase }}{% endif %}) {% endfor %}
    {% for language in validator-libraries %}
  • {{language.name}}
      {% for implementation in language.implementations %}
    • {{ implementation.name }} 
          <em>
    {% if implementation.date-draft %}
        {{ implementation.date-draft | join: ", "}}{% if implementation.draft %}, {% endif %}
    {% endif %}
    {% if implementation.draft %}
        draft-0{{ implementation.draft | join: ", -0" }}
    {% endif %}
    </em>

    {{implementation.notes | markdownify | remove: '<p>' | remove: '</p>'}}

    {% if implementation.license %}
        ({{ implementation.license | join: ", " }})
    {% endif %}

    </li>
{% endfor %}
</ul>
      • {% endfor %}

    Benchmarks

    Benchmarks that compare at least two implementations supporting draft-06+ may be listed here.

    • Go

    • JavaScript

      • json-schema-benchmark - an independent benchmark for Node.js JSON-schema validators based on JSON-Schema Test Suite (MIT)

    • PHP

      • php-json-schema-bench - comparative benchmark for JSON-schema PHP validators using JSON-Schema Test Suite and z-schema/JSCK (MIT)

    Hyper-Schema

    {% assign hyper-schema-libraries = site.data.hyper-libraries-modern | sort:"name" %}

    {% for language in hyper-schema-libraries %}

    • [{{ language.name }}](#hyper-schema-{% if language.anchor-name %}{{ language.anchor-name }}{% else %}{{ language.name | downcase }}{% endif %}) {% endfor %}
      {% for language in hyper-schema-libraries %}
    • {{language.name}}
        {% for implementation in language.implementations %}
      • {{ implementation.name }} 
            {% if implementation.draft %}
        <em>draft-0{{ implementation.draft | join: ", -0" }}</em>
    {% endif %}

    {{implementation.notes | markdownify | remove: '<p>' | remove: '</p>'}}

    {% if implementation.license %}
        ({{ implementation.license | join: ", " }})
    {% endif %}

    </li>
{% endfor %}
</ul>
        • {% endfor %}

      API documentation

      • JavaScript

      • Python

        • FastAPI (MIT) is an API framework based on Python 3.6+ types that generates OpenAPI 3 schemas, including JSON Schemas for all the models declared.

      Link Description Object utilities

      Schema generators

      Schema generators need not support generating every schema keyword. For schema generators, compatibility with a draft means that either:

      • Schemas produced explicitly set the draft with $schema
      • Schemas produced lack $schema but are valid against the appropriate meta-schema

      For example, the only incompatibilities between draft-04 and draft-06 involve exclusiveMinimum, exclusiveMaximum, and id vs $id. If a generator does not set $schema and does not ever emit those keywords, then it is compatible with draft-06 even if it was written with draft-04 in mind.

      From code

      • .NET
        • Json.NET (AGPL-3.0) - generates schemas from .NET types
        • NJsonSchema - (Ms-PL) - generates schemas from .NET types, see issue 574 for draft-06+ support progress
      • Golang
        • qri-io/jsonschema(MIT) - idiomatic go implementation with custom validator support, coding to and from json, rich error returns supports Draft 7
      • PHP
        • Liform (MIT) - generates schemas from Symfony forms
      • TypeScript
      • Python
        • Pydantic (MIT) - generates schemas from Python models based on Python 3.6+ type hints.
      • Java
      • Scala

      From data

      • Scala
        • Schema Guru (Apache 2.0) - CLI util, Spark Job and Web UI for deriving JSON Schemas out of corpus of JSON instances; see issue 178 for progress towards draft-06+ support
      • Online (web tool)
        • jsonschema.net - generates schemas from example data
        • quicktype.io - infer JSON Schema from samples, and generate TypeScript, C++, go, Java, C#, Swift, etc. types from JSON Schema

      Generators from schemas

      Tools that generate artifacts from schemas need not support every keyword, as not all keywords work well for generative use cases.

      Generators are considered compatible with a draft if they support (or benignly ignore) the appropriate $schema value, and interpret the keywords that they do support according to that draft.

      For example, if a generator that was originally written for draft-04 does not support id, exclusiveMinimum, or exclusiveMaxium, then as long as it does not require a draft-04 $schema, it is compatible with draft-06 since those are the only keywords that changed.

      Code generation

      • Delphi
        • DJsonSchema (MIT) - JSON Schema reader and code generator for Delphi.
      • Elm
      • Java
        • jsonCodeGen (MIT) - Groovy based generation tasks from JSON schema. Already includes templates/generators for Java Beans, Swagger specification files and PlantUML diagrams.
      • Online (web tool)
        • quicktype.io - infer JSON Schema from samples, and generate TypeScript, C++, go, Java, C#, Swift, etc. types from JSON Schema
      • PHP

      Web UI generation

      TODO: Sort by draft support.

      Various levels of support for UI generation primarily from the validation vocabulary or combined with UI specific definition.

      Data from schemas

      • Python
        • hypothesis-jsonschema (MPL) draft-07, -06, -04; takes any schema, even with complex and interacting constraints, and returns a Hypothesis strategy which can generate valid documents for testing.

      Utilities

      Draft compatibility for utilities is generally specific to the purpose of the utility, and decided on a case-by-case basis.

      General processing

      • JavaScript
        • json-schema-ref-parser (MIT) Tools for dereferencing non-cyclic schemas, bundling referenced schemas into a single file, and other $ref processing.
        • @cloudflare/json-schema-walker (JSON Schema Tools), draft-07, -06, -04, and Cloudflare's Doca extensions Walks schemas and runs pre- and post-walk callbacks. Can modify schemas in place. (BSD-3-Clause)

      Schema to Schema

      Schema draft migration

      None currently support draft-06 or later.

      Format converters

      Testing

      • Python
        • hypothesis-jsonschema (MPL) draft-07, -06, -04; takes any schema, even with complex and interacting constraints, and returns a Hypothesis strategy which can generate valid documents for testing.

      Editors

      TODO: Sort by draft support.

      • Altova XMLSpy 2019r3 - Graphical JSON Schema editor for draft-06 and draft-7, as well as validation of JSON files based on JSON Schema
      • Liquid XML Studio 2016 - Graphical JSON schema editor for draft 4, context sensitive intellisense for JSON documents.
      • Visual Studio 2013 - Auto-completion and tooltips based on JSON schema draft 3 and draft 4
      • JSONBuddy - Text and grid-style JSON editor and validator with context sensitive entry-helpers and sample data generation based on JSON schema. Support for draft 4, draft 6 and draft 7.
      • ReSharper 2016.1 - code completion, inspections and quick fixes for JSON schema in Visual Studio 2010 - 2015, including support for JSON Path and regular expressions for schema editing
      • Visual Studio Code - Schema driven code completion, hovers and validation for editing JSON files (including schemas)
      • JSONEditor Online - View, edit, format, and validate JSON online
      • JSON Schema Editor - An intuitive editor for JSON schema online
      • JSON Editor - An online, schema-aware editor for JSON document
      • Eclipse IDE - Rich JSON edition supporting schema for instantaneous validation and error reporting, completion, documentation.
      • WebStorm, IntelliJ IDEA, and other JetBrains IDEs - Code completion, documentation, and validation for JSON and YAML files using JSON Schema
      • JsonDraft - Tree view JSON and JSON Schema editor online. Create and Save reusable components, Share JSON.

      Schema Repositories

      Schema Linter

      • json-schema-linter - Lint/validate/parse json-schema itself and find out out typo, missing properties, missing required keys etc. Supports draft 4, 6, and 7.