README.md

api-diff-viewer

React component to view the difference between two Json based API documents. Supported specifications: JsonSchema, OpenAPI 3.x, AsyncAPI 2.x.

View online demo and

Current status and plans:

• JsonSchema support
• OpenApi 3.x support
• Swagger support
• AsyncApi 2.x support
• Side-by-side compare view
• Inline compare view
• Yaml output
• Json output
• Compare text by words
• Collapse/expand blocks
• View change summary on collaped blocks
• Collapse/expand all
• Filter changes by type (Hide unchanged/not filtered lines)
• Navigation sidebar
• Non-blocking loading (via WebWorker)
• Custom themes support
• Default themes
• WebComponent
• Performance improvement
• Tests

Documentation

Installation

# Yarn
yarn add api-diff-viewer

# NPM
npm install api-diff-viewer

✨ Checkout the stories here for a detailed documentation.

Development

Install

yarn install

Develop

yarn storybook

License

MIT