json-schema-diff

What is json-schema-diff?

The json-schema-diff npm package is a tool for comparing JSON schemas. It helps identify differences between two JSON schemas, which can be useful for versioning, migration, and ensuring compatibility between different versions of APIs or data structures.

What are json-schema-diff's main functionalities?

Compare JSON Schemas

This feature allows you to compare two JSON schemas and identify the differences between them. The code sample demonstrates how to use the json-schema-diff package to compare two schemas and print the differences.

const jsonSchemaDiff = require('json-schema-diff');

const schema1 = {
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'number' }
  },
  required: ['name']
};

const schema2 = {
  type: 'object',
  properties: {
    name: { type: 'string' },
    age: { type: 'number' },
    email: { type: 'string' }
  },
  required: ['name', 'email']
};

jsonSchemaDiff.diffSchemas({
  sourceSchema: schema1,
  destinationSchema: schema2
}).then((diff) => {
  console.log(JSON.stringify(diff, null, 2));
}).catch((error) => {
  console.error(error);
});

Other packages similar to json-schema-diff

json-diff

The json-diff package provides a way to compare two JSON objects and highlight the differences. While it is not specifically designed for JSON schemas, it can be used to compare any JSON data structures. It is more general-purpose compared to json-schema-diff, which is specialized for JSON schema comparison.

deep-diff

The deep-diff package allows for deep comparison of JavaScript objects, including JSON objects. It can be used to find differences between two objects at any depth. Similar to json-diff, it is not specialized for JSON schemas but can be used for a wide range of JSON data comparisons.

diff

The diff package is a general-purpose text comparison tool that can be used to compare JSON strings. It provides a variety of diff algorithms and output formats. While it is not specifically designed for JSON schemas, it can be used to compare JSON data by converting it to strings.

README

Json Schema Diff

A language agnostic CLI tool and nodejs api to identify differences between two json schema files.

Requirements

• nodejs 6.x or higher (tested using 6.x, 8.x and 9.x)
• npm 2.x or higher (tested using 2.x, 3.x and 5x)

Installation

Install the tool using npm and add it to the package.json

npm install json-schema-diff --save-dev

Usage

Todo

Changelog

See CHANGELOG.md

Contributing

See CONTRIBUTING.md

License

See LICENSE.txt

Changelog

0.2.0 (2018-04-23)

Features

• add support for the allOf keyword (e329acd)

<a name="0.1.0"></a>