swagger-diff自动生成 API ChangeLog 组件
自动生成 API ChangeLog 组件。
用来比较两个由Swagger生成的API文档，对参数、返回类型、路径进行深度比较，并输出差异(HTML格式、Markdown格式)，适用于自动生成接口变更文档。
前提
jdk 1.6+
特性
-
Support swagger1.x and swagger2.0
-
Support HTTP请求方法比较: get post put delete...
-
Support Requestbody参数比较
-
Support API文档的鉴权Auth读取
-
EL(Expression Language)表达式
-
HTML 渲染、markdown 渲染
Maven
<dependency>
<groupId>com.deepoove</groupId>
<artifactId>swagger-diff</artifactId>
<version>1.1.0</version>
</dependency>
快速入门
SwaggerDiff可以从JSON文件或者HTTP URL中读取API-DOC。
final String SWAGGER_V2_DOC1 = "petstore_v2_1.json";
final String SWAGGER_V2_DOC2 = "http://petstore.swagger.io/v2/swagger.json";
SwaggerDiff diff = SwaggerDiff.compareV2(SWAGGER_V2_DOC1, SWAGGER_V2_DOC2);
Swagger版本
v1.x版本
SwaggerDiff.compareV1(SWAGGER_V1_DOC1, SWAGGER_V1_DOC2);
v2.0版本
SwaggerDiff.compareV2(SWAGGER_V2_DOC1, SWAGGER_V2_DOC2);
工作原理
评论