Swagger-diff使用
Sayi/Swagger官方文档
sayi/Swagger-diff的github地址
sayi/Swagger-diff的官方文档
github拉下来代码之后 打.jar包
由于下载下来的Java项目需要达成jar包运行.json代码,打jar包需要maven环境的支持。
maven安装方式:
windows10 64bit 选择 Binary zip archive
apache-maven-3.6.1-bin.zip
然后根据自己需求进行安装就可以
maven常用命令
mvn compile //编译源代码
mvn test-complie //编译测试代码
mvn test //运行测试
mvn package // 打包 根据pom.xml打成war或者jar
mvn -Dtest package //打包但不测试。完整命令为:mvn -D maven.test.skip=true package
mvn install //在本地Repository中安装jar
mvn clean //清除产生的项目
mvn eclipse:eclipse //生成eclipse项目
mvn idea:idea //生成idea项目
mvn eclipse:clean //清除eclipse的一些系统设置
mvn dependency:sources //下载源码
mvn compile -pl auth/auth-web -am //只针对特定模块进行编译检查的方法
jar包形成的方式 需要安装maven 执行命令:
mvn package
对比执行方式
$ java -jar swagger-diff.jar \
>-old swagger.json \
>-new swagger16.json \
>--output > diff.html
执行模板:
$ java -jar swagger-diff.jar --help
Usage: java -jar swagger-diff.jar [options]
Options:
* -old //顾名思义,就是拿来对比的原始json文件(上一版本保存下来的json)
old api-doc location:Json file path or Http url
* -new //新版本的json文件地址
new api-doc location:Json file path or Http url
-v
swagger version:1.0 or 2.0
Default: 2.0
-output-mode
//输出格式可选内容,如果代码中支持swagger-ui的情况下可以使用mode
render mode: markdown or html
Default: markdown
<