OpenApi和Swagger2 Swagger3的关系

已于 2022-09-15 16:41:30 修改
阅读量2.3w 收藏 5
点赞数 4
分类专栏： 辅助开发 Swagger 文章标签： spring 接口 swagger2 openApi swagger3
于 2022-08-30 15:59:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_15022971/article/details/126589478
版权

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项目下载

今天例外
关注
  • 4
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
大神带你玩转后端开发神器Swagger3——一篇文章精通接口文档自动生成Swagger3和OpenApi规范（已完结）
JAVA求生之路——博主406766467
01-25 855
文章目录一、OpenApi规范：声明了用于文档的规范的版本二、自动化接口文档生成解决方案介绍2.1 ApiDoc介绍2.2 Swagger 丝袜哥 介绍三、Swagger SpringFox 简单介绍3.1 Swagger介绍3.2 SpringFox介绍（是 spring 社区维护的一个非官方项目）四、（重点）基于OpenAPi规范，SpringBoot整合Swagger4.1 导入相关依赖4.2 配置文件4.3 配置类4.4 启动项目，查看结果五、Swagger3常用注解讲解和配置5.1 @Api 模块
vscode-openapi-viewer:vsAPI的OpenAPI或swagger文档预览
05-17
OpenAPI文档查看器 查看器文档 该项目仍在进行中。 特征 使用预览文档API规范 使用摇头TODO验证文档OpenAPI规范 支持发送本机请求TODO 支持开关主题TODO 要求 用法 运行命令⇧⌘P的OpenAPI：预览。 第三方图书馆/...
OpenApi3/Swagger3简单使用及与swagger2对比
Aplumage的专栏
05-25 8219
OpenApi3/Swagger3简单使用及与swagger2对比
推荐文章：探索OpenAPI与JSON Schema的桥梁——openapi2jsonschema
最新发布
gitblog_00050的博客
05-31 543
推荐文章：探索OpenAPI与JSON Schema的桥梁——openapi2jsonschema 项目地址:https://gitcode.com/instrumenta/openapi2jsonschema 在当今快速发展的软件生态中，API已成为不同系统间沟通的重要渠道。开放API（OpenAPI）规范以其强大的描述能力和广泛的工具支持，成为了定义RESTful API的标准方法。然而，你是...
openapi3和openapi2的注解区别
stu_kk的博客
04-27 305
openapi3和openapi2的注解区别
OpenAPI使用（swagger3），Kotlin使用swagger3，Java使用swagger3，gradle、Maven使用swagger3
了迹奇有没
06-28 1601
OpenAPI使用（swagger3） 一、背景及名词解释 OpenAPI是规范的正式名称。规范的开发工作于2015年启动，当时SmartBear（负责Swagger工具开发的公司）将Swagger 2.0规范捐赠给了Open API Initiative，该协会由来自技术领域不同领域的30多个组织组成。此后，该规范被重命名为OpenAPI规范。 Swagger 是一个 API文档维护组织，后来成为了 Open API 标准的主要定义者。现在最新的版本为17年发布的 Swagger3（Open Api3）
Swagger2和openAPI3注解对比
banyejiu的博客
09-26 4411
Swagger2和Swagger3对比 swagger2 OpenAPI 3 注解位置 @Api @Tag(name = “接口类名”,description = “接口类描述”) Controller 类上 @ApiOperation @Operation(summary =“接口方法描述”) Controller 方法上 @ApiImplicitParams @Parameters Controller 方法上 @ApiImplicitParam @Parameter(des
openapi-webconverter:Mermade Swagger 2.0至OpenAPI 3.0.0转换器前端
05-02
在线Swagger 2.0到OpenAPI 3.0.x转换器Swagger 2.0定义或OpenAPI 3.0.x定义转换和验证由执行您也可以使用转换Swagger 2.0定义或验证3.0.x定义POST / api / v1 / convert-使用源或文件名参数，还可以使用validate = ...
swaggerplusplus:在Swagger 2.0和OpenAPI 3.0.x之间过渡的建议
05-10
在Swagger 2.0和OpenAPI 3.0.x之间过渡的建议 版本1.0.0-rc4 关键字“必须”，“必须”，“必须”，“应”，“应不”，“应”，“不应”，“建议”，“不建议”，“可以”和“可选”当且仅当它们以大写字母出现时，...
openapi-preview:使用Swagger UI预览OpenAPI规范
05-07
OpenAPI预览 使用预览OpenAPI规范 aasaam软件开发小组
SpringBoot集成OpenAPI(Swagger3)和Mybatis-plus代码生成器
08-04
本文主要介绍openAPI(Swagger3)和Mybatis-Plus代码生成器技术，然后将两者进行集成，并且自我定制，达到使用生成代码的同时，能够按照我们的要求定制我们所需要的代码，以及注释，并且和openAPI进行集成，形成...
基于SwaggerSwaggeropenapi30规范通过配置SwaggerJSON生成API文档
08-14
基于Swagger，Swagger open api 3.0 规范，通过配置Swagger JSON 生成API 文档
openapi2typescript:一个被大范围使用的小工具
03-15
如果你看不懂里面的代码，就不要用这个工具
从SpringFox向SpringDoc转移（OpenAPI2向OpenAPI3转移）
m0_47333020的博客
11-18 4127
转移原因 在学习使用spring集成swagger3时查阅文档发现 SpringFox未支持 OpenAPI3 标准，而是还在支持2017年就已经停止维护的OpenAPI2了 而搜遍全网写OpenAPI3的教程少的可怜 但还是找到了与之相关的文章 文章跳转 但没有关于权限验证的相关教程，答案还得去官网找 官网链接 转移步骤 删除springfox和swagger 2依赖项。而是添加springdoc-openapi-ui依赖 2.替换注解 3.替换Docket 添加OpenAPI类型的
Swagger 2 权威指南——第2章 OpenAPI详解（2）
程序员客栈
12-18 475
2.2 媒体类型 媒体类型表示请求或响应体正文数据的格式，Web服务操作可以接受和返回不同格式的数据，最常见的是JSON、XML和图片。你可以在请求和响应定义中指定媒体类型，如下所示： paths: /employees: get: summary: Returns a list of employees. responses: '200': ...
Swagger2 权威指南——第2章 OpenAPI详解（3）
程序员客栈
12-18 2777
2.3 路径和操作 在OpenAPI术语中，路径是API公开的端点（资源），例如，/users，而操作是用于操作这些路径的HTTP方法，例如，GET、POST或DELETE等。 2.3.1 路径 API路径和操作在API规范的全局部分paths中定义。 paths: /ping: ... /users: ... /users/{id}: ... 上面定...
API接口管理Swagger 2的使用及注解介绍（Spring boot 2.6.4 + Springfox 3）
lushuai_1986的专栏
02-26 1346
Spring Boot 2.6.4 + Springfox 3.0.0 集成、配置、注解介绍
Swagger3.0.0
weixin_45365220的博客
03-31 2228
作为一个RESTful风格的可视化框架，经常会和yapi作个比较， 相比于yapi其优势展现在： 自动实时更新接口信息 更强大的接口信息描述注解 劣势在于： 代码侵入性强 UI不如Yapi好看（当然swagger的UI页面支持引入更换，且swagger3的UI比以往版本好看一些） Yapi还有权限管理、团队协作、自动化测试等功能 Swagger3目前已经将注解规范化，基于openApi3，且兼容以往版本的注解和配置 今天我们来看看简单的Swagger3版本整合到springboot项目中 pom依赖
【自动生成接口文档】Sofaboot集成Swagger3并通过Yapi做接口管理
热门推荐
不是很懂
08-31 2万+
Sofaboot集成Swagger3并通过Yapi做接口管理
swagger3 和 swagger2 的区别？
04-26
Swagger是一种用于设计、构建和文档化RESTful API的开源框架。Swagger2和Swagger3是Swagger的两个主要版本，它们之间有以下几点区别： 1. 规范：Swagger2使用OpenAPI规范2.0，而Swagger3使用OpenAPI规范3.0。OpenAPI规范3.0相对于2.0有一些重要的改进和更新。 2. 结构：Swagger2使用JSON或YAML格式来描述API文档，而Swagger3只使用YAML格式。Swagger3还引入了一种新的方式来组织和定义API文档，使用了更简洁和可读性更好的结构。 3. 组件：Swagger3引入了一些新的组件，如服务器对象、回调对象和链接对象等。这些组件使得API文档更加丰富和灵活。 4. 安全性：Swagger3在安全性方面进行了改进，引入了更多的安全定义选项和机制，使得API的安全性配置更加灵活和强大。 5. 扩展性：Swagger3提供了更好的扩展性，允许用户自定义和扩展各种元素和组件，以满足特定的需求。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值