Skip to content
This repository has been archived by the owner on Nov 2, 2023. It is now read-only.

Latest commit

 

History

History
404 lines (314 loc) · 26.3 KB

implementations.md

File metadata and controls

404 lines (314 loc) · 26.3 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, or that are no longer in development, 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.

Listing does not signify a recommendation or endorsement of any kind.

Validators

{% assign validator-libraries = site.data.validator-libraries-modern | sort: 'name' %}

{% 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}} {% if language.notes %}

    {{ language.notes }}

    {% endif %}
      {% for implementation in language.implementations %}
    • {{ implementation.name }}
      • Supports: {% if implementation.date-draft and implementation.date-draft != empty %} {{ implementation.date-draft | sort | reverse | join: ", " }} {%- if implementation.draft and implementation.draft != empty %}, {% endif %} {% endif %} {% if implementation.draft and implementation.draft != empty %} draft-0{{ implementation.draft | sort | reverse | join: ", -0" }} {% endif %} 
        •     {% if implementation.compliance %}
      <li><em>Compliance:</em>
      {% if implementation.compliance.config.docs %}
        This implementation <a href="{{ implementation.compliance.config.docs }}">documents</a> that you must
      {% endif %}
      {% if implementation.compliance.config.instructions %}
        <strong>{{ implementation.compliance.config.instructions | markdownify | remove: '<p>' | remove: '</p>' }}</strong> to produce specification-compliant behavior.
      </li>
      {% endif %}
    {% endif %}

    {% if implementation.built-on %}
      <li><em>Built on:</em>
        <a href="#{{ implementation.built-on.anchor-name | default: implementation.built-on.name }}">{{ implementation.built-on.name }}</a>
      </li>
    {% endif %}

    {% if implementation.license %}
      <li><em>License:</em>
        {{ implementation.license | join: ", " }}
      </li>
    {% endif %}

    {% if implementation.notes %}
      <li><em>Notes:</em>
        {{ implementation.notes | markdownify | remove: '<p>' | remove: '</p>' }}
      </li>
    {% endif %}

    {% if implementation.last-updated %}
      <li><em>Information last updated:</em>
        {{ implementation.last-updated }}
      </li>
    {% endif %}

    </ul>
  </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)

      API documentation

      • JavaScript

        • @cloudflare/doca (JSON Schema Tools), draft-04, -06, -07, and Doca extensions (UI forthcoming)
        • @adobe/jsonschema2md makes it easier by providing a number of scripts that can turn JSON Schema files into readable Markdown documentation that is ready for consumption on GitHub or processed using Jekyll or other static site generators. JSON Schema 2019-09 (partial)

      • 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
      • Go
        • jsonschema - (MIT) - generate schemas from Go structs. Supports Draft 2020-12.
      • PHP
        • Liform (MIT) - generates schemas from Symfony forms
      • TypeScript
      • Python
        • Pydantic (MIT) - generates schemas from Python models based on Python 3.6+ type hints.
        • msgspec (BSD-3-Clause) - generates schemas from Python type annotations.
        • mashumaro (Apache 2.0) - generates schemas from Python type annotations
        • drf-jsonschema-serializer (BSD-3-Clause) - generates schemas from Django Rest Framework serializers
      • Java
        • jsonschema-generator (Apache 2.0) - generates schemas from Java types supports Draft 7 and Draft 2019-09
      • Scala
      • Ruby
        • Shale (MIT) - generates schema from Ruby models supports Draft 2020-12
      • Rust
        • Schemars (MIT) - generates schema from Rust code supports Draft 7

      From data

      • Java
        • saasquatch/json-schema-inferrer 2020-12, 2019-09, draft-07, draft-06, draft-04 (Apache 2.0) - Java library for inferring JSON Schemas from one or multiple JSON samples.
      • 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
        • JSONoid (MIT) - command line tool and Spark application for inferring schemas from JSON documents, supports draft 2019-09
      • Clojure
      • Online (web tool)
        • jsonschema.net - generates schemas from example data
        • Liquid Online Tools - infer JSON Schema from sample JSON data
        • quicktype.io - infer JSON Schema from samples, and generate TypeScript, C++, go, Java, C#, Swift, etc. types from JSON Schema

      From model

      • Dataspecer - Generates JSON Schema (and JSON-LD context) from conceptual model supports Draft 2020-12

      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

      • Dotnet
        • Corvus.JsonSchema - generates an idiomatic dotnet type model from JSON Schema files, supporting all JSON Schema features, including property accessors, enumeration, common string format, and JSON document building/modification; over low-level System.Text.Json types. supports Draft 6, Draft 7, Draft 2019-09 and Draft 2020-12.
      • Elm
      • Go
        • go-jsonschema - generates Go types and helpers from JSON schema files supports Draft 2020-12
        • protoc-gen-jsonschema - Generates JSON schemas from protobuf proto v2 and v3 files.
      • Java
        • jsonCodeGen (MIT) - Groovy based generation tasks from JSON schema. Already includes templates/generators for Java Beans, Swagger specification files and PlantUML diagrams.
        • jsonschema2pojo (Apache 2.0) - generates Java types from JSON Schema (or example JSON) and can annotate those types for data-binding with Jackson 2.x or Gson. draft-07
        • jsonschematypes (Apache 2.0) - Java library to generate Java or TypeScript classes from standard JSON Schemas. JSON Schema 2019-09, draft-07, -06, -04, -03
        • jsongenerator JSON Schema 2019-09, draft-07, -06, -04, -03 (Apache-2.0)
      • Kotlin
      • Online (web tool)
        • quicktype.io - infer JSON Schema from samples, and generate TypeScript, C++, go, Java, C#, Swift, etc. types from JSON Schema
      • PHP
      • Python
        • yacg (MIT) - parse JSON Schema and OpenApi files to build a meta model from them. This meta model can be used in Mako templates to generate source code, other schemas or plantUml.
        • statham (MIT) - generate type-annotated models from JSON Schema documents.
      • Rust
        • schemafy - generates Rust types and serialization code from a JSON schema. supports Draft 4
      • Scala
        • json-schema-to-case-class (MIT) - NPM Package, Web UI and a CLI to generate Scala case classes from JSON Schema. Supports JSON Schema 2019-09, draft-07, -06, -04, -03
      • TypeScript
        • jsongenerator JSON Schema 2019-09, draft-07, -06, -04, -03 (Apache-2.0)
      • Ruby
        • Shale (MIT) - generates Ruby models from a JSON schema supports Draft 2020-12

      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

      • .Net
      • 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.
      • Java
        • jsongenerator JSON Schema 2019-09, draft-07, -06, -04, -03 (Apache-2.0)

      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.
        • json-schema-library (MIT) - Exposes tools to work with json-schema, including: data creation from json-schema, $ref processing, walk through schemas, etc.
        • @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)
        • @hyperjump/json-schema-core (MIT) Tools for working with schemas that handle identifiers and references. Build vocabularies and other JSON Schema based tools.

      Schema to Schema

      Schema draft migration

      • JavaScript
        • AlterSchema JSON Schema 2020-12, 2019-09, draft-07, -06, -04

      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

      • Altova XMLSpy 2019r3 - Graphical JSON Schema editor for draft-06 and draft-7, as well as validation of JSON files based on JSON Schema
      • Dashjoin JSON Schema editor - Graphical online JSON Schema editor for draft-06 (minus oneOf, anyOf, allOf, not). The generated schema can be tested immediately via a form that is driven by it.
      • Hackolade Studio - Visual JSON Schema editor for draft-04, draft-06, draft-07, 2019-09, 2020-12, as well as data modeling tool for NoSQL databases, storage formats, REST APIs, and JSON in RDBMS. Also converts to and from: different draft specifications, DDL, XSD, Swagger, OpenAPI, YAML, Avro, Parquet, Protobuf, and most of the NoSQL script syntaxes. Includes a GUI for Entity-Relationship Diagrams and a Command-Line Interface.
      • JSONBuddy - Text and grid-style JSON editor and validator. Complete JSON Schema development environment with JSON Schema analyzer, context sensitive entry-helpers, sample data generation based on JSON Schema and JSON Schema validation debugger: Step through the validation process and set breakpoints. JSON Schema testing tool including schema coverage. Support for draft-4, draft-6, draft-7, 2019-09 and 2020-12.
      • JSONEditor Online - View, edit, format, and validate JSON online Support draft-4, draft-6, and draft-7.
      • Liquid JSON Schema Editor - Graphical JSON Schema editor for draft-04, draft-06, draft-07 and 2019-09, with split source code and grphical editing. Includes validation of JSON files based on JSON Schema, JSON Sample Generator and JSON Schema Documentation Generator.
      • Oxygen JSON Schema Editor - JSON Schema editor with a variety of editing features and helper views (Design/Text/Author). Support for validation and editing JSON Schema draft-4, draft-6, and draft-7, 2019-09 (partial), 2020-12 (partial). Validation and editing of JSON files based on JSON Schema.
      • Perseid Modeler - a modeling tool for JSON Schema and OpenAPI. Key features include: visual JSON schema creation using tree and ERD-like diagrams, support for JSON schema structures including operators and conditions, import of existing schemas from files, creation of detailed HTML reports, export to PDF, script generation, and more. Supported versions: draft 4, 6, 7, 2019-09 and 2020-12
      • Stoplight Studio - JSON Schema IDE (text-based and GUI) with support for JSON/YAML linting, which can also be based on JSON Schema rules via Spectral. Support for draft-4, draft-6 and draft-7.
      • Visual Studio Code - Schema driven code completion, hovers and validation for editing JSON files (including schemas)
      • WebStorm, IntelliJ IDEA, and other JetBrains IDEs - Code completion, documentation, and validation for JSON and YAML files using JSON Schema. Support for draft-4, draft-6, and draft-7.
      • Eclipse IDE - Rich JSON edition supporting schema for instantaneous validation and error reporting, completion, documentation.

      Documentation generators

      • docusaurus-json-schema-plugin - Schema viewer. Runs within a Docusaurus web app. Supports draft-7, 2019-09, Draft 2020-12
      • json-schema-static-docs - Generates human friendly markdown documentation from JSON Schema. Includes links between pages based on $ref values. Supports draft-7.
      • jsonschematic - Svelte-based schema viewer. Runs as a local web app. Supports draft-7.
      • docson - Javascript-based schema viewer. Runs as a local web app. Supports draft-4.
      • json-schema-for-humans - Generate HTML representation of a schema. Python-based. Supports draft-7.
      • oXygen JSON Schema Documentation - Generate JSON Schema documentation in HTML format including diagrams.
      • wetzel - Generates Markdown and AsciiDoc. With some limitations, supports draft-3, draft-4, draft-7, and 2020-12.

      Schema Repositories

      Schema Linter

      • json-schema-linter - Lint/validate/parse json-schema itself, and find typos, missing properties, missing required keys, etc. Supports draft 4, 6, and 7.
      • Stoplight Spectral - A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI v2/v3 and JSON Schema. Supports draft 4, 6, and 7.

      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 %}

    {% if implementation.last-updated %}
      <br />
      <em>Information last updated:</em>
      {{ implementation.last-updated }}
    {% endif %}


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