GithubHelp home page GithubHelp logo

naterkane / json-schema-converter Goto Github PK

View Code? Open in Web Editor NEW

This project forked from clever/archived-json-schema-converter

0.0 2.0 0.0 469 KB

Utilities to translate your schema into anything, as long as 'anything' is JSON Schema.

License: Apache License 2.0

Makefile 6.22% CoffeeScript 92.61% JavaScript 1.18%

json-schema-converter's Introduction

JSON Schema Converter

A translation and validation library between JSON Schema and any other schema.

Don't get locked into your database schema forever- make sure you can always use the latest, most buggy most trendy database with minimal work.

With the JSON Schema converter, you can also validate your schemas. No matter what db client you're using, you can be confident a schema matches what the client expects.

###Currently supported:

Installation

npm install json-schema-converter

Usage

{inspect} = require 'util'
json_schema = require 'json-schema-converter'
your_schema = require 'your_schema.json'

# to make sure - validate returns a structure that describes the error
unless json_schema.is_valid your_schema
  throw new Error "JSON Schema is invalid, error is: #{inspect json_schema.validate(your_schema)}"

# the actual conversion
your_mongoose_schema = json_schema.to_mongoose_schema your_schema

# now instantiate
your_mongoose_object = new mongoose.Schema your_mongoose_schema

# and you're on your way...
# want to convert back? See the examples!

See the examples for usage.

Future Path

Right now we only support Mongoose schemas, but we hope to translate any schema to JSON schema and back as effortlessly as possible.

json-schema-converter's People

Contributors

jonahkagan avatar rgarcia 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.