4
4
5
5
#### Parse, Resolve, and Dereference JSON Schema $ref pointers
6
6
7
- [ ![ Build Status] ( https://github.com/APIDevTools/json-schema-ref-parser/workflows/CI-CD/badge.svg?branch=master )] ( https://github.com/APIDevTools/json-schema-ref-parser/actions )
8
- [ ![ Coverage Status] ( https://coveralls.io/repos/github/APIDevTools/json-schema-ref-parser/badge.svg?branch=master )] ( https://coveralls.io/github/APIDevTools/json-schema-ref-parser )
7
+ <!-- [](https://github.com/APIDevTools/json-schema-ref-parser/actions)
8
+ [](https://coveralls.io/github/APIDevTools/json-schema-ref-parser) -->
9
9
10
- [ ![ npm] ( https://img.shields.io/npm/v/@apidevtools/json-schema-ref-parser.svg )] ( https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser )
11
- [ ![ License] ( https://img.shields.io/npm/l/@apidevtools/json-schema-ref-parser.svg )] ( LICENSE )
12
- [ ![ Buy us a tree] ( https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen )] ( https://plant.treeware.earth/APIDevTools/json-schema-ref-parser )
10
+ <!-- [](https://www.npmjs.com/package/@apidevtools/json-schema-ref-parser)
11
+ [](LICENSE) -->
13
12
14
13
## Installation
15
14
@@ -58,13 +57,10 @@ complex [JSON Schemas](http://json-schema.org/latest/json-schema-core.html) and
58
57
JavaScript objects.
59
58
60
59
- Use ** JSON** or ** YAML** schemas &mdash ; or even a mix of both!
61
- - Supports ` $ref ` pointers to external files and URLs, as well
62
- as [ custom sources] ( https://apitools.dev/json-schema-ref-parser/docs/plugins/resolvers.html ) such as databases
63
- - Can [ bundle] ( https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#bundlepath-options-callback ) multiple
64
- files into a single schema that only has _ internal_ ` $ref ` pointers
65
- - Can [ dereference] ( https://apitools.dev/json-schema-ref-parser/docs/ref-parser.html#dereferencepath-options-callback )
66
- your schema, producing a plain-old JavaScript object that's easy to work with
67
- - Supports [ circular references] ( https://apitools.dev/json-schema-ref-parser/docs/#circular-refs ) , nested references,
60
+ - Supports ` $ref ` pointers to external files and URLs, as well as custom sources such as databases
61
+ - Can bundle multiple files into a single schema that only has _ internal_ ` $ref ` pointers
62
+ - Can dereference your schema, producing a plain-old JavaScript object that's easy to work with
63
+ - Supports circular references, nested references,
68
64
back-references, and cross-references between files
69
65
- Maintains object reference equality &mdash ; ` $ref ` pointers to the same value always resolve to the same object
70
66
instance
88
84
}
89
85
```
90
86
91
- For more detailed examples, please see the [ API Documentation] ( https://apitools.dev/json-schema-ref-parser/docs/ )
92
-
93
87
## Polyfills
94
88
95
89
If you are using Node.js < 18, you'll need a polyfill for ` fetch ` ,
@@ -130,16 +124,6 @@ config.plugins.push(
130
124
);
131
125
```
132
126
133
- ## API Documentation
134
-
135
- Full API documentation is available [ right here] ( https://apitools.dev/json-schema-ref-parser/docs/ )
136
-
137
- ## Contributing
138
-
139
- I welcome any contributions, enhancements, and
140
- bug-fixes. [ Open an issue] ( https://github.com/APIDevTools/json-schema-ref-parser/issues ) on GitHub
141
- and [ submit a pull request] ( https://github.com/APIDevTools/json-schema-ref-parser/pulls ) .
142
-
143
127
#### Building/Testing
144
128
145
129
To build/test the project locally on your computer:
@@ -152,19 +136,3 @@ To build/test the project locally on your computer:
152
136
153
137
3 . ** Run the tests** <br >
154
138
` yarn test `
155
-
156
- ## License
157
-
158
- JSON Schema $Ref Parser is 100% free and open-source, under the [ MIT license] ( LICENSE ) . Use it however you want.
159
-
160
- This package is [ Treeware] ( http://treeware.earth ) . If you use it in production, then we ask that you [ ** buy the world a
161
- tree** ] ( https://plant.treeware.earth/APIDevTools/json-schema-ref-parser ) to thank us for our work. By contributing to
162
- the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
163
-
164
- ## Big Thanks To
165
-
166
- Thanks to these awesome companies for their support of Open Source developers ❤
167
-
168
- [ ![ Stoplight] ( https://svgshare.com/i/TK5.svg )] ( https://stoplight.io/?utm_source=github&utm_medium=readme&utm_campaign=json_schema_ref_parser )
169
- [ ![ SauceLabs] ( https://jstools.dev/img/badges/sauce-labs.svg )] ( https://saucelabs.com )
170
- [ ![ Coveralls] ( https://jstools.dev/img/badges/coveralls.svg )] ( https://coveralls.io )
0 commit comments