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);
工作原理
评论
Regan API基于注释自动生成 API 文档
ReganAPI前言ReganAPI 项目是基于注释自动生成api文档,很大缩短了开始与后期维护API接口文档的时间。 ReganAPI 利用jdk提供的Doclet类读取文档注释,可手动配置需要读取
Regan API基于注释自动生成 API 文档
0
Panda.DynamicWebApiC# 动态生成 Web API 的组件
Panda.DynamicWebApi 是一个动态生成WebApi的组件,生成的API符合Restful风格,受启发于ABP。它可以根据符合条件的类来生成WebApi,由MVC框架直接调用逻辑,无性能
Panda.DynamicWebApiC# 动态生成 Web API 的组件
0
Panda.DynamicWebApiC# 动态生成 Web API 的组件
Panda.DynamicWebApi 是一个动态生成 WebApi 的组件,生成的 API 符合
Panda.DynamicWebApiC# 动态生成 Web API 的组件
0
Google API Go Client自动生成 Go 语言 API
Google API Go Client 可以自动生成 Google 的 Go 语言 API。示例代
Google API Go Client自动生成 Go 语言 API
0
Google API Go Client自动生成 Go 语言 API
GoogleAPIGoClient可以自动生成Google的Go语言API。示例代码:package mainimport ( "container/list" "encoding/jso
Google API Go Client自动生成 Go 语言 API
0
Regan API SpringBoot基于注释自动生成 API 文档
Regan_API_SpringBoot项目介绍Regan_API_SpringBoot 文档项目
Regan API SpringBoot基于注释自动生成 API 文档
0