Giter VIP home page Giter VIP logo

xema's Introduction

Xema

Hex.pm CI Coverage Status License: MIT

Xema is a schema validator inspired by JSON Schema. For now, Xema supports the features documented in draft 04, 06, and 07 of the JSON-Schema specification.

Xema allows you to annotate and validate elixir data structures.

If you search for a real JSON Schema validator give JsonXema a try.

Xema is in beta. If you try it and has an issue, report them.

Installation

First, add Xema to your mix.exs dependencies:

def deps do
  [{:xema, "~> 0.13"}]
end

Then, update your dependencies:

$ mix deps.get

Docs

The docs contains a Usage page with a short and compact description to use Xema.

Documentation can be generated with ExDoc by running mix docs. The generated docs can be found at https://hexdocs.pm/xema.

Tests

The test in the directory xema/test/json_schema_test_suite are generated from the JSON-Schema-Test-Suite.

The test suite can be generated with mix gen.test_suite. The mix task expected the suite in the root directory in the folder JSON-Schema-Test-Suite.

References

The home of JSON Schema: http://json-schema.org/

Specification:

Understanding JSON Schema a great tutorial for JSON Schema authors and a template for the description of Xema.

xema's People

Contributors

depressed-pho avatar garret-smith avatar nickneck avatar romul avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.