https://github.com/postmanlabs/xsd2jsonschema
A pure JavaScript library for translating complex XML Schemas into JSON Schemas.
https://github.com/postmanlabs/xsd2jsonschema
Last synced: 4 months ago
JSON representation
A pure JavaScript library for translating complex XML Schemas into JSON Schemas.
- Host: GitHub
- URL: https://github.com/postmanlabs/xsd2jsonschema
- Owner: postmanlabs
- License: apache-2.0
- Fork: true (andrewbober/xsd2jsonschema)
- Created: 2021-04-16T14:30:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-24T08:43:47.000Z (almost 4 years ago)
- Last Synced: 2024-09-29T18:21:28.880Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.xsd2jsonschema.org
- Size: 2.58 MB
- Stars: 4
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### A pure JavaScript library for translating complex XML Schemas into JSON Schemas.
[](https://app.codeship.com/projects/104942)
[](https://coveralls.io/github/andrewbober/xsd2jsonschema?branch=master)
[](https://badge.fury.io/gh/andrewbober%2Fxsd2jsonschema)
[](https://badge.fury.io/js/xsd2jsonschema)
## Looking to convert schemas using a command line interface?
If you want to convert XML Schemas into JSON Schemas without any coding please see the forthcoming companion command line interface [xsd2jsonschema-cli](https://www.npmjs.org/package/xsd2jsonschema-cli).
## Install
```
npm install xsd2jsonschema
```
## Quickstart
```javascript
const XML_SCHEMA = `
`;
const Xsd2JsonSchema = require('xsd2jsonschema').Xsd2JsonSchema;
const xs2js = new Xsd2JsonSchema();
const convertedSchemas = xs2js.processAllSchemas({
schemas: {'hello_world.xsd': XML_SCHEMA}
});
const jsonSchema = convertedSchemas['hello_world.xsd'].getJsonSchema();
console.log(JSON.stringify(jsonSchema, null, 2));
```
## Features:
1. JSON Schema draft-04/06/07 are supported as of version 0.3.0.
2. Supports large mutli-file XML schemas with circular imports or includes, forward references, and any number of XML namespaces.
3. Preserves the original file organization in the resulting schema conversion.
4. Conversion logic has several configurable options and can be customized with your own code.
5. A companion command line interface is planned. Please see [xsd2jsonschema-cli](https://www.npmjs.org/package/xsd2jsonschema-cli).
## Documentation (TBD)
[Options](www.xsd2jsonschema.org/quickstartvideos)
[Videos](www.xsd2jsonschema.org/quickstartvideos)
[Reference](https://www.xsd2jsonschema.org/documentation)
## Where to file issues
[https://github.com/andrewbober/xsd2jsonschema/issues](https://github.com/andrewbober/xsd2jsonschema/issues)
## Developing
Please see the [Wiki](https://github.com/andrewbober/xsd2jsonschema/wiki/Developing) for an overview of the code and outstanding development needs.
## Node & Npm version requirements
* Node - Version 6.11.0 LTS or higher
* Npm - Version 3.10.0 or higher
## Tools
* Created with [Visual Studio Code](https://github.com/Microsoft/vscode), [site](http://code.visualstudio.com)
* Continuous Integration by [Codeship](https://codeship.com)
* Test coverage history & statistics by [Coveralls.io](http://coveralls.io)
## References
1. [Definitive XML Schema, 2nd Edition](https://www.amazon.com/Definitive-XML-Schema-Priscilla-Walmsley/dp/0132886723), [site](https://www.pearsonhighered.com/program/Walmsley-Definitive-XML-Schema-2nd-Edition/PGM282380.html)
2. [XML Schema](https://www.w3.org/XML/Schema)
3. [JSON Schema](http://www.json-schema.org)
4. [XML Schema Test Suite](https://www.w3.org/XML/2004/xml-schema-test-suite) - The official World Wide Web Consortium (WC3) XML Schema Test Suite
## License
Copyright (C) 2019 Andrew Bober
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.