OpenApi和Swagger

OpenApi是业界真正的 api 文档标准,其是由 Swagger 来维护的,并被linux列为api标准,从而成为行业标准。
目前OpenApi的版本:
	

 - OpenApi2 对应Swagger的实现版Swagger2
	Swagger2已经于17年停止维护,对应的包名:io.swagger  
 - OpenApi3对应Swagger的实现版Swagger3
	Swagger3于17年开始开发,对应的包名:io.swagger.core.v3

Swagger的依赖包

Swagger2的依赖路径
swagger2的依赖路径
Swagger3的依赖路径
swagger3的依赖路径

我们可以看到上面Swagger2和Swagger3的依赖路径不一致
springfox和springdoc分别是spring社区的两个项目,
springfox帮助开发者将swagger2集成Spring,并且可以在springboot中轻松使用
springdoc帮助开发者将swagger3集成Spring.并且可以在springboot中轻松使用
但是springdoc的swagger3并不如swagger2流行,主要是因为
swagger3对swagger2的兼容性很差. 左边是OpenApiSwagger3注解右边是Swagger2注解

swagger3和swagger2关键注解对比
上图就是swagger3和swagger2的关键注解对比,可以看到变化很大,而且swagger3并没有兼容swagger2,所以导致swagger2迁移swagger3成本比较大.

后来springfox为了支持swagger3自己做了自己的兼容,依赖如下
在这里插入图片描述
兼容原来swagger2的注解,如何使用?

相关链接

Springboot集成Swagger2并通过Yapi做接口管理
Springboot集成OpenAPI-Swagger3并通过Yapi做接口管理
Springboot集成springFox-Swagger3并通过Yapi做接口管理
Sofaboot集成Swagger3并通过Yapi做接口管理
swagger-yapi-demo项目下载

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐