swagger跟openAPI不同

今年是OpenAPI 3.0的正式发布,这是OpenAPI规范的最新版本。

对于那些从事API开发的人来说,OAS 3.0的发布是一件大事。

为什么?该版本如此重要的最显着原因之一是,OpenAPI 3.0是该规范的第一个正式版本,因为它是由SmartBear Software捐赠给OpenAPI Initiative,并在2015年从Swagger规范重命名为OpenAPI规范。

在我们探讨OpenAPI 3.0在API空间中如此重要的一些原因之前,首先必须弄清有关OpenAPI及其对Swagger的含义的一些问题,这一点很重要。

在过去的两年中,关于从Swagger转换为OpenAPI的问题很多。而且,关于OpenAPI和Swagger之间的区别,何时使用一个名称代替另一个名称以及OpenAPI和Swagger之间的关系还有很多困惑。
让我们从澄清Swagger与OpenAPI开始
理解差异的最简单方法是:
OpenAPI =规范
Swagger =实现规范的工具

OpenAPI是规范的正式名称。该规范的开发是由OpenAPI Initiative推动的,该倡议涉及更多来自技术领域不同领域的30个组织-包括Microsoft,Google,IBM和CapitalOne。领导Swagger工具开发的公司Smartbear Software也是OpenAPI Initiative的成员,帮助领导了规范的发展。

Swagger是与用于实现OpenAPI规范的一些最著名,使用最广泛的工具相关联的名称。Swagger工具集包括开源工具,免费工具和商业工具的组合,可在API生命周期的不同阶段使用。

这些工具包括:

Swagger编辑器:使用 Swagger编辑器,您可以在浏览器内的YAML中编辑OpenAPI规范,并实时预览文档。
Swagger UI: Swagger UI是HTML,Javascript和CSS资产的集合,这些资产从符合OAS的API动态生成精美的文档。
Swagger Codegen:允许在给定OpenAPI规范的情况下自动生成API客户端库(SDK生成),服务器存根和文档。
Swagger Parser:用于从Java解析OpenAPI定义的独立库
Swagger Core: Java相关的库,用于创建,使用和使用OpenAPI定义
Swagger Inspector(免费): API测试工具,可让您验证API并从现有API生成OpenAPI定义
SwaggerHub(免费和商业): API设计和文档,为使用OpenAPI的团队而构建。
由于Swagger工具是由参与创建原始Swagger规范的团队开发的,因此通常仍将这些工具视为该规范的代名词。但是Swagger工具并不是唯一可用于实现OpenAPI规范的工具。有各种各样的API设计,文档,测试,管理和监视解决方案都支持该规范的2.0版,并且正在积极致力于增加3.0支持。

您可以在GitHub上找到支持最新版本的OpenAPI规范的工具的完整列表。

Swagger工具为什么没有将其名称更改为OpenAPI?
Swagger生态系统一直由规范和围绕它的核心开源工具组成,其中最著名的是Swagger UI,Swagger编辑器和Swagger Codegen。规范之所以被广泛采用的一个重要原因是其附带的工具。

SmartBear捐赠了该规范,但由于开发人员,技术作家,测试人员和设计师与该工具有着密切的联系,因此流行的开源Swagger工具仍保留了原始品牌。该规范不是,也从未完全与Swagger工具相关联。实际上,决定捐赠规范并组成OpenAPI Initiative是为了确保OpenAPI完全与供应商无关。这就是为什么我们很高兴看到API领域有这么多,包括也支持其他定义格式(例如API蓝图和RAML)的公司加入了该计划的原因。

Swagger团队始终致力于使用OpenAPI规范构建功能最强大,最易于使用的工具,以设计,记录,开发和测试API,并将继续发展和发展我们的工具集以支持OpenAPI。这些工具将继续保持Swagger名称。Swagger工具和在线Swagger项目的在线主页Swagger.io也将继续成为学习Swagger工具的理想之地,并且我们还将继续为OpenAPI规范的知识做出贡献,通过有关使用OpenAPI的培训,教程,网络研讨会和文档。

了解OpenAPI和Swagger社区
尽管为OpenAPI做出贡献的人们与为Swagger工具做出贡献的人们之间总是会存在重叠,但是这两个社区是彼此独立的。

如本文所述,OpenAPI Initiative是一个开放的,与供应商无关的组织,欢迎任何想要帮助发展或利用其API开发中的规范的人参与。邀请组织加入不断增加的对规范做出贡献的成员列表,并且欢迎个人参加,在GitHub上分享想法和反馈,或参加每月在世界各地举行的许多OAS聚会之一。在此处了解有关如何做出贡献的更多信息。

Swagger工具拥有自己的社区,致力于帮助改进某些现有Swagger项目,并引入新的想法和功能要求。Swagger社区是由SmartBear Software的团队培育的,该团队投资于开源Swagger工具的开发,但也受到世界各地成千上万Swagger用户的贡献的推动。如果您想加入Swagger社区,我们邀请您在GitHub上找到我们或加入Swagger API Meetup组。您还可以在Swagger博客或Twitter上的@SwaggerAPI上找到最新新闻和更新。

期待OpenAPI的美好未来
我们期待看到OpenAPI成为API领域中每个人都认可的名称,并且我们很高兴成为不断增长的OpenAPI Initiative成员社区的一部分。

希望本文有助于阐明有关OpenAPI及其与Swagger的关系的一些问题。

回顾一下:

该规范在2015年重命名为OpenAPI规范。OpenAPI3.0是该规范的最新版本。
SmartBear Software支持的Swagger工具是实现OpenAPI规范的最受欢迎的工具之一,并且将继续维护Swagger名称(Swagger编辑器,Swagger UI,SwaggerHub等)。
还有数百种与Swagger不相关的其他开源和专业工具都支持OpenAPI 2.0规范,并且支持3.0的工具列表也在不断增长。
OpenAPI和Swagger都有开源社区,欢迎所有贡献者加入以分享他们的想法并参与其中。
如果您有同事,朋友或正在使用API​​的任何其他人仍然有一些问题,我们希望您能分享这篇文章。Swagger团队将努力帮助阐明Swagger与OpenAPI之间的关系,我们希望您也能做到!

  • 6
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值