api-smart-diff
Advanced tools
Compare two api specifications, supported formats: OpenAPI, AsyncAPI, JsonSchema
This package provides utils to compute the diff between two API specifications.
npm install api-smart-diff
import { syncApiDiff } from 'api-smart-diff'
const diff = syncApiDiff(oldSpec, newSpec, "OpenApi3")
// {
// action: "add" | "remove" | "replace",
// after: 'value after',
// before: 'value before',
// path: ['path, 'in', 'array'],
// type: "annotation" | "breaking" | "non-breaking" | "unclassified"
// }
Browser folder contains an Ubundle allowing you to either reference api-smart-diff.min.js in your HTML or import module using Require.js.
Reference apispec-diff.min.js in your HTML and use the global variable ApiSmartDiff.
<script src="node_modules/api-smart-diff/browser/api-smart-diff.min.js"></script>
<script>
var diff = ApiSmartDiff.syncApiDiff (oldSpec, newSpec, "OpenApi3")
</script>
MIT
FAQs
Generate the diff between two API specifications (OpenAPI, AsyncAPI, GraphApi, JsonSchema)
We found that api-smart-diff demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.