expand-json-schema

Light weight JSON Schema $ref resolver. Expands a JSON Schema by resolving $ref references from a mapping of definitions. Does not handle remote references. Has comprehensive unit tests and no dependencies.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

1$ npm install --save expand-json-schema

Usage

1import { expandSchema } from 'expand-json-schema';
2// or
3import expandSchema from 'expand-json-schema';
4
5const schema = {
6  $ref: '#/definitions/User'
7};
8
9// Resolves $refs from a mapping of objects/definitions passed as the second argument
10const expandedSchema = expandSchema(schema, definitions);
11console.log(expandedSchema);

API

expandSchema(schema, definitions, options)

Expands a JSON Schema by resolving $ref references from a mapping of definitions, and applying basic transformations such as sorting keys and handling nullable fields.

Params

• schema {Object}: The schema to be expanded.
• definitions {Object}: An object containing schema definitions.
• options {Object}: Optional configuration settings.
  • paths {Array}: Custom paths to resolve $ref from.
  • sortOrder {Array}: Custom key sort order.

Returns

• {Object}: The expanded schema.

Examples

Example: Basic Schema Expansion

1const schema = {
2  $ref: '#/definitions/User'
3};
4const definitions = {
5  User: {
6    type: 'object',
7    properties: {
8      name: { type: 'string' },
9      age: { type: 'integer' }
10    }
11  }
12};
13
14const result = expandSchema(schema, definitions);
15console.log(result);
16// Output: {
17//   type: 'object',
18//   properties: {
19//     name: { type: 'string' },
20//     age: { type: 'integer' }
21//   }
22// }

Example: Handling Nullable Properties

1const schema = {
2  type: 'string',
3  nullable: true
4};
5
6const result = expandSchema(schema);
7console.log(result);
8// Output: {
9//   type: ['string', 'null']
10// }

Example: Inlining Definitions

The second argument (definitions) is used along with the paths option to resolve $refs. Definitions are then inlined onto the schema. The combination of these two options not only allows for a more flexible way to resolve references, but it gives you an easy to prevent unwanted objects from being included in the search, when objects are dynamicaly resolved.

1const definitions = {
2  models: {
3    User: {
4      type: 'object',
5      properties: {
6        id: { type: 'string' }
7      }
8    }
9  },
10  types: {
11    Address: {
12      type: 'object',
13      properties: {
14        street: { type: 'string' }
15      }
16    }
17  }
18};
19
20const schema = {
21  properties: {
22    user: { $ref: '#/models/User' },
23    address: { $ref: '#/types/Address' }
24  }
25};
26
27const result = expandSchema(schema, definitions, {
28  paths: ['models', 'types']
29});
30
31console.log(result);
32// Output:
33// {
34//   definitions: {
35//     User: {
36//       type: 'object',
37//       properties: {
38//         id: { type: 'string' }
39//       }
40//     },
41//     Address: {
42//       type: 'object',
43//       properties: {
44//         street: { type: 'string' }
45//       }
46//     }
47//   },
48//   properties: {
49//     user: { $ref: '#/definitions/User' },
50//     address: { $ref: '#/definitions/Address' }
51//   }
52// }

Example: Resolving Nested References

1const components = {
2  definitions: {
3    User: {
4      type: 'object',
5      properties: {
6        name: { type: 'string' }
7      }
8    }
9  }
10};
11
12const schema = {
13  $ref: '#/definitions/User'
14};
15
16const result = expandSchema(schema, components);
17console.log(result);
18// Output: {
19//   type: 'object',
20//   properties: {
21//     name: { type: 'string' }
22//   }
23// }

Example: Handling Custom Paths

1const components = {
2  custom: {
3    path: {
4      UserType: {
5        type: 'object',
6        properties: {
7          name: { type: 'string' }
8        }
9      }
10    }
11  }
12};
13
14const schema = {
15  $ref: '#/custom/path/UserType'
16};
17
18const result = expandSchema(schema, components, {
19  paths: ['custom/path']
20});
21console.log(result);
22// Output: {
23//   type: 'object',
24//   properties: {
25//     name: { type: 'string' }
26//   }
27// }

About

1$ npm install && npm test

1$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2024, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.8.0, on November 10, 2024.