Code Monkey home page Code Monkey logo

gextech.refaker's Introduction

A JSON-schema $ref faker

Inspired on json-schema-validator for JAVA, the --fakeroot option, actually.

If you're validating some RAML (like me) then you should validate your JSON-schemas and examples also.

For this purpose I'm using ramlev which is using tv4, but you're encouraged to download any $ref manually before validating.

Solution?

var tv4 = require('tv4'),
    refaker = require('refaker');

var data = { /* ... */ },
    schema = { /* ... */ };

refaker({
  schema: schema,
  fakeroot: 'http://example.com',
  directory: '/path/to/schemas'
}, function(err, refs, schemas) {
  if (err) {
    console.log(err);
  } else {
    for (var id in refs) {
      // register resolved refs
      tv4.addSchema(id, refs[id]);
    }

    // validates the first passed schema
    console.log(tv4.validateResult(data, schemas[0]));
  }
});

That's it.

Options

  • schema (object|aray)

    The JSON-schema to validate.

  • schemas (object|array)

    Multiple JSON-schemas to validate at once.

    This is an alias for the schema option.

  • fakeroot (string)

    If provided, any matching $ref will be resolved under the specified directory.

  • directory (string)

    A local path containing the JSON-schemas.

    If missing, will use process.cwd() instead.

Any $ref found will be downloaded or faked locally.

Callback

The given callback will receive three arguments:

  • err (mixed)

    Empty means success.

  • refs (object)

    Hash of resolved $refs.

  • schemas (array)

    Normalized schemas if success (same order as input).

Build status

Build Status NPM version Coverage Status

gextech.refaker's People

Contributors

pateketrueke avatar

Watchers

James Cloos avatar Brenton House 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.