{"id":15792731,"url":"https://github.com/mikeralphson/openapi-diff","last_synced_at":"2026-04-16T08:32:56.664Z","repository":{"id":66094165,"uuid":"158676563","full_name":"MikeRalphson/openapi-diff","owner":"MikeRalphson","description":"Mirror of Atlassian's OpenAPI Diff (from bitbucket.org)","archived":false,"fork":false,"pushed_at":"2018-11-22T09:46:38.000Z","size":371,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-11T23:16:16.813Z","etag":null,"topics":["api","diff","json","openapi","openapi3","swagger","yaml"],"latest_commit_sha":null,"homepage":"https://bitbucket.org/atlassian/openapi-diff/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MikeRalphson.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-22T09:45:42.000Z","updated_at":"2018-11-22T09:53:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"c6d334ff-5ffc-4f76-86b3-f8fad1ee6144","html_url":"https://github.com/MikeRalphson/openapi-diff","commit_stats":{"total_commits":160,"total_committers":5,"mean_commits":32.0,"dds":"0.24375000000000002","last_synced_commit":"a05e3e92aee83d2f0f3b5a6fbf738e83ce7d225c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/MikeRalphson/openapi-diff","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fopenapi-diff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fopenapi-diff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fopenapi-diff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fopenapi-diff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MikeRalphson","download_url":"https://codeload.github.com/MikeRalphson/openapi-diff/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MikeRalphson%2Fopenapi-diff/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259340639,"owners_count":22843031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","diff","json","openapi","openapi3","swagger","yaml"],"created_at":"2024-10-04T23:03:22.898Z","updated_at":"2026-04-16T08:32:51.645Z","avatar_url":"https://github.com/MikeRalphson.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Diff\n\u003e A CLI tool to identify differences between Swagger/OpenAPI specs.\n\n## Requirements\n- nodejs 6.x or higher (tested using 6.x, 8.x and 10.x)\n- npm 3.x or higher (tested using 3.x and 5x)\n\n## Installation\n\nInstall the tool using npm and add it to the package.json\n```\nnpm install openapi-diff --save-dev\n```\n\nAvoid installing the tool globally as this will lead to problems when multiple codebases try to use different versions\nof the tool on the same machine.\n\n## Usage\nInvoke the tool with two paths to Swagger/OpenAPI files in order to find differences between them, these paths can\neither be paths to the specs in the local filesystem or URLs to the specs, both JSON and YAML are supported.\n```\n./node_modules/.bin/openapi-diff /path/to/source/openapi.json /path/to/destination/openapi.json\n./node_modules/.bin/openapi-diff /path/to/source/openapi.yml /path/to/destination/openapi.yml\n```\n\nThe tool's output will display the amount and type of changes, and then list the changes with the relevant info.\nChanges are classified as follows:\n\n* Breaking: changes that would make existing consumers incompatible with the API (deletion of paths, adding required\nproperties...)\n* Non-breaking: changes that would **not** make existing consumers incompatible with the API (addition of paths,\nturning a required property into optional...)\n* Unclassified: changes that have been detected by the tool but can't be classified (modifications to X-Properties and\nother unforeseen changes)\n\nThe command will exit with an exit code 1 if any breaking changes were found, so that you can fail builds in CI when\nthis happens.\n\n## Feature support\nSee [SPEC_SUPPORT.md](SPEC_SUPPORT.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeralphson%2Fopenapi-diff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikeralphson%2Fopenapi-diff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikeralphson%2Fopenapi-diff/lists"}