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:

• [x] JsonSchema support
• [x] OpenApi 3.x support
• [ ] Swagger support
• [x] AsyncApi 2.x support
• [x] Side-by-side compare view
• [x] Inline compare view
• [x] Yaml output
• [x] Json output
• [x] Compare text by words
• [x] Collapse/expand blocks
• [x] View change summary on collaped blocks
• [x] Collapse/expand all
• [x] Filter changes by type (Hide unchanged/not filtered lines)
• [x] Navigation sidebar
• [x] Non-blocking loading (via WebWorker)
• [x] 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