Getting Started

How and why to use JsonSchema.

In order to go straight to the API description of this library, start by looking at the JsonSchema module.

Project Setup

To use JsonSchema with your projects, edit your mix.exs file and add it as a dependency.

defp deps do
  [{:json_schema, "~> 0.1"}]
end

What is JsonSchema

JsonSchema is a library that parses JSON schema documents into Elixir structs and allows inspection and manipulation of the parsed documents. This library is meant as a basis for writing other libraries or tools that need to use JSON schema documents. For example, a JSON schema validator that validates a JSON object according to a JSON schema specification, or a code generator that generates a data model and accompanying JSON decoders/encoders based on the JSON schema specification of an API — the project JSON Schema to Elm is an example of such a tool.