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 ❤️ and support.

Install

Install with npm:

$ npm install --save expand-json-schema

Usage

import { expandSchema } from 'expand-json-schema';
// or
import expandSchema from 'expand-json-schema';

const schema = {
  $ref: '#/definitions/User'
};

// Resolves $refs from a mapping of objects/definitions passed as the second argument
const expandedSchema = expandSchema(schema, definitions);
console.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

const schema = {
  $ref: '#/definitions/User'
};
const definitions = {
  User: {
    type: 'object',
    properties: {
      name: { type: 'string' },
      age: { type: 'integer' }
    }
  }
};

const result = expandSchema(schema, definitions);
console.log(result);
// Output: {
//   type: 'object',
//   properties: {
//     name: { type: 'string' },
//     age: { type: 'integer' }
//   }
// }

Example: Handling Nullable Properties

const schema = {
  type: 'string',
  nullable: true
};

const result = expandSchema(schema);
console.log(result);
// Output: {
//   type: ['string', 'null']
// }

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.

const definitions = {
  models: {
    User: {
      type: 'object',
      properties: {
        id: { type: 'string' }
      }
    }
  },
  types: {
    Address: {
      type: 'object',
      properties: {
        street: { type: 'string' }
      }
    }
  }
};

const schema = {
  properties: {
    user: { $ref: '#/models/User' },
    address: { $ref: '#/types/Address' }
  }
};

const result = expandSchema(schema, definitions, {
  paths: ['models', 'types']
});

console.log(result);
// Output:
// {
//   definitions: {
//     User: {
//       type: 'object',
//       properties: {
//         id: { type: 'string' }
//       }
//     },
//     Address: {
//       type: 'object',
//       properties: {
//         street: { type: 'string' }
//       }
//     }
//   },
//   properties: {
//     user: { $ref: '#/definitions/User' },
//     address: { $ref: '#/definitions/Address' }
//   }
// }

Example: Resolving Nested References

const components = {
  definitions: {
    User: {
      type: 'object',
      properties: {
        name: { type: 'string' }
      }
    }
  }
};

const schema = {
  $ref: '#/definitions/User'
};

const result = expandSchema(schema, components);
console.log(result);
// Output: {
//   type: 'object',
//   properties: {
//     name: { type: 'string' }
//   }
// }

Example: Handling Custom Paths

const components = {
  custom: {
    path: {
      UserType: {
        type: 'object',
        properties: {
          name: { type: 'string' }
        }
      }
    }
  }
};

const schema = {
  $ref: '#/custom/path/UserType'
};

const result = expandSchema(schema, components, {
  paths: ['custom/path']
});
console.log(result);
// Output: {
//   type: 'object',
//   properties: {
//     name: { type: 'string' }
//   }
// }

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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.