openapi-drift-checker 是一个规划中的工具,用于检测 API 文档页面与 OpenAPI 规范之间的偏差。其核心思路是把 OpenAPI 规范视为 API 接口的唯一事实来源,再找出散文式指南、教程和参考页面与规范不一致的地方。
用途 该工具面向 API 文档维护场景,目标是在规范与文档之间建立一致性检查,帮助发现文档中过时、错误或缺失的接口描述。
主要能力(按规划)
- 从文件或 URL 加载 OpenAPI 3.x 或 Swagger 2.0 规范。
- 提取操作、参数、schema、枚举、默认值和认证方案。
- 在 Markdown 文档和代码示例中查找端点、参数和字段的提及。
- 按严重程度报告漂移,包括被删除或重命名的条目、错误的类型或取值、未记录的新增条目。
- 提出文档修改建议,并标记规范本身可能出错的情况。
使用方式 暂未提供。当前状态为仅脚手架,尚未准备好使用,因此没有可执行的安装命令、调用方式或配置步骤。
适用场景 适用于需要维护 API 参考文档、教程与代码示例一致性的团队,尤其是以 OpenAPI 或 Swagger 规范驱动文档的 API 项目。
限制 该工具目前不可用,仅为占位说明。上述能力均为计划内容,尚未实现。收费、价格、平台支持、实际效果和使用步骤暂未提供。