Skip to content

apester-dev/JSON-Schema-Instantiator

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSON-Schema-Instantiator

A simple tool for instantiating JSON Schemas, with Angular support!

Installing

Node.js

npm install json-schema-instantiator

AngularJS

bower install angular-schema-instantiator

Using

Node.js

var instantiator = require('json-schema-instantiator');

...

var schema = {
    "type": "object",
    "properties": {
        "title": {
            "type": "string",
            "default": "Example"
        },
        "description": {
            "type": "string"
        }
    },
    "required": ["title"]
};

instance = instantiator.instantiate(schema);
// instance === { title: "Example", description: "" }

instance = instantiator.instantiate(schema, {requiredPropertiesOnly: true});
// instance === { title: "Example", description: "" }

instance = instantiator.instantiate(schema, {requiredPropertiesOnly: false});
// instance === { title: "Example" }

AngularJS

Add the sources to index.html:

<script src="/deoxy?target=https%3A%2F%2Fgithub.com%2Fapester-dev%2Fjson-schema-instanciator%2Fsrc%2Finstantiator.js"></script>
<script src="/deoxy?target=https%3A%2F%2Fgithub.com%2Fapester-dev%2Fjson-schema-instanciator%2Fsrc%2Fangular-instantiator.js"></script>

Include the module:

angular.module('myApp', ['schemaInstantiator'])

...

Inject the InstantiatorService and use it:

...

.controller({
    MyCtrl: ['InstantiatorService', function(Instantiator) {
        var schema = {
            type: "string",
            default: "Hello!"
        };
        
        console.log(Instantiator.instantiate(schema));
        // Hello!
    }]
})

...

About

A simple tool for instantiating JSON Schemas.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 100.0%