About openapi-diff
This repository contains source code of openapi-diff aka oad aka "Breaking change detector tool" npm package.
This package is invoked internally by the azure-rest-api-specs and azure-rest-api-specs-pr repos
Swagger Breaking Change and Breaking Change(Cross-Version) GitHub checks, validating PRs submitted to them.
For description of the overall process of which oad is part of, see https://aka.ms/azsdk/specreview .
npm package
[!CAUTION]oad
How to run locally
See relevant section in CONTRIBUTING.md
@azure/oad 是什么？ OpenApi Specification Diff tool
如何安装 @azure/oad？ 在项目目录运行 npm install @azure/oad，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 oad，可以用 npx oad 直接运行。
@azure/oad 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@azure/oad 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@azure/oad 需要什么版本的 Node.js？ package.json 的 engines 字段要求 Node.js >=20.19.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@azure/oad 可以商用吗？ @azure/oad 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@azure/oad 的下载量有多少？ 根据 npm 官方下载统计，@azure/oad 在 2026/10/08 – 2026/11/06 这 30 天内被下载 38,750 次，日均约 1,292 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@azure/oad 还在维护吗？ 最新版本 0.12.4 发布于 2026/03/17（7 个月前）；至今共发布 55 个版本，其中过去 12 个月发布了 1 个；首次发布于 2019/03/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。
. It is deprecated and obsolete.