search

jsonsystems / json-schema

JSONSchema.Net Public Repository
Apache License 2.0
663 stars 64 forks source link

readme

Repo Archived

Please use https://github.com/jsonsystems/public

Welcome to JSONschema.Net

[Hex.pm]()

  1. Contact
  2. What is JSONSchema.Net?
  3. Who uses JSONSchema.Net?
  4. What is JSONSchema.Net’s goal?
  5. How can your organization benefit from using JSONSchema.Net?
  6. Specifications
  7. About
  8. Cookie Policy
  9. Privacy Policy

Contact

What is JSONSchema.Net?

JSONSchema.Net is a web application that generates JSON schema from JSON. JSON Schema is generated according to the JSON Schema Validation: A Vocabulary for Structural Validation of JSON.

Who uses JSONSchema.Net?

Anyone wishing to generate JSON schema from JSON. Typical users are web developers and mobile app developers. Some educational institutions also use JSONSchema.Net to teach JSON Schema and the core options defined by JSON Schema Validation.

What is JSONSchema.Net’s goal?

JSON Schema is great, but can be verbose. For example, a single empty JSON object, {}, can be described by:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "additionalProperties": true,
  "definitions": {},
  "id": "http://example.com/example.json",
  "properties": {
    "description": "This accepts anything, as long as it's valid JSON.",
    "title": "Empty Object"
  },
  "type": [
    "object",
    "null"
  ]
}

Even schemas for small APIs can quickly become hundreds of lines long. Writing schemas by hand is tedious and time consuming, and often impractical. JSONSchema.Net makes schema generation quick and painless.

How can your organization benefit from using JSONSchema.Net?

JSONSchema.Net can save you and anyone on your team a lot of time. If your software uses JSON, it's good practice to validate any (JSON) data it receives, against a schema.

Specifications

JSON Schema specificaiton is split into three parts

  1. Core - The basic foundation of JSON Schema.
  2. Validation - The validation keywords of JSON Schema.
  3. Hyper-Schema - The hyper-media keywords of JSON Schema.

JSONSchema.Net follows the Validation part of the overall specification. json-schema.org/specification.html is a good place to learning more.

Versioning of JSON Schema specifications can be confusing. json-schema.org maintains a helpful list of specification-links. In reverse chronological order:

Each version updates (to varying degrees) the three parts of JSON Schema specification: Core, Validation, and Hyper-Schema.

About

Created by Jack Wootton. Copyright 2017. Apache Licensed.

Cookie Policy

Our cookie policy can be read at cookies.md

Privacy Policy

Our privacy policy can be read at privacy.md