tufin/oasdiff Docker 镜像 - 轩辕镜像

tufin/oasdiff Docker镜像文档

概述

tufin/oasdiff是一个专为OpenAPI Specification 3（原Swagger）设计的差异比较工具，用于分析和展示两个OpenAPI规范文件之间的差异，支持多种输出格式，适用于API版本变更管理、文档差异审计等场景。

核心功能特性

• 支持OpenAPI Specification 3规范文件的差异比较
• 多种输出格式：文本/Markdown、HTML、YAML
• 支持比较公开URL的OpenAPI文件
• 支持比较本地文件（通过挂载卷实现文件访问）

使用场景

• API版本升级时的接口变更检查
• OpenAPI文档版本间差异审计
• 自动化API文档变更报告生成
• 开发与测试环境API规范一致性验证

使用方法与示例

比较公开文件（文本/Markdown输出）

通过URL比较两个公开的OpenAPI文件，输出文本/Markdown格式的差异结果：

bash
docker run --rm -t tufin/oasdiff -format text -base [***] -revision [***]

比较公开文件（HTML输出）

通过URL比较两个公开的OpenAPI文件，输出HTML格式的差异结果：

bash
docker run --rm -t tufin/oasdiff -format html -base [***] -revision [***]

比较公开文件（YAML输出）

通过URL比较两个公开的OpenAPI文件，输出YAML格式的差异结果：

bash
docker run --rm -t tufin/oasdiff -format yaml -base [***] -revision [***]

比较本地文件（YAML输出）

比较本地文件系统中的两个OpenAPI文件（需挂载本地目录到容器）：

bash
docker run --rm -t -v $(pwd)/data:/data:ro tufin/oasdiff -base /data/openapi-test1.yaml -revision /data/openapi-test3.yaml

项目仓库

更多信息请访问项目GitHub仓库：[***]