https://github.com/darosh/json-schema-bundler

Lightweight JSON Schema reference parser
https://github.com/darosh/json-schema-bundler

javascript json-schema

Last synced: 1 day ago
JSON representation

Lightweight JSON Schema reference parser

• Host: GitHub
• URL: https://github.com/darosh/json-schema-bundler
• Owner: darosh
• License: mit
• Created: 2017-07-13T12:54:10.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-04-22T09:11:36.000Z (over 6 years ago)
• Last Synced: 2024-11-03T08:34:11.627Z (12 days ago)
• Topics: javascript, json-schema
• Language: JavaScript
• Homepage: https://darosh.github.io/json-schema-bundler/test/
• Size: 95.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JSON Schema Bundler

Lightweight JSON Schema reference parser. See [demo online](https://darosh.github.io/json-schema-bundler/test/).

## Features

- Bundles external [JSON Schema](http://json-schema.org/) references into internal references

- Dereferences internal references

- Works with JSON and YAML format

- Bundles external text file formats as well

- Follows [specification](http://json-schema.org/latest/json-schema-core.html#rfc.section.8): *All other properties in a "$ref" object MUST be ignored.*

- By default requires [axios](https://github.com/mzabriskie/axios) and [yamljs](https://github.com/jeremyfa/yaml.js) but can be replaced by alternatives via injection

- [Promise](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise) API

- Runs in browser and server

- HTTP and file system on server

- Loading progress report

- Internal file cache available (for offline [PWA](https://developers.google.com/web/progressive-web-apps/)s)

- Small **8 KB** footprint

## Usage

**Disclaimer:** Work in progress! 

### Browser

[./test/index.html](./test/index.html)

### Node

[./test/index-http.js](./test/test-http.js) and [./test/index-fs.js](./test/test-fs.js)

## Alternatives

See [./test/benchmark.html](https://darosh.github.io/json-schema-bundler/test/benchmark.html).

- [BigstickCarpet/json-schema-ref-parser](https://github.com/BigstickCarpet/json-schema-ref-parser)