跳至主要内容

支持 OpenAPI 规范的工具

作者: 2023年3月8日博客, 新闻

在过去的 18 个月里,我们一直在研究如何更好地捕获 OpenAPI 生态系统中的数据,尤其关注工具 - 工具制造商在做什么,他们支持哪些版本的 OpenAPI 等等。工具注册表显然已经存在于野外,例如 openapi.tools。目标不是复制这些注册表的功能,而是使用一种易于扩展的机制来实现数据收集过程的工业化,并且可以通过非常有限的修改来扩展。

推出我们的 OpenAPI 工具注册表。该注册表公开了一个基于“经典”UI 的注册表,托管在 https://tools.openapis.org.cn,它使用来自现有注册表的数据并使用从(作为第一个版本)Github API 收集的数据进行提升。这种机制由 Mike Ralphson 证明并用于发布 https://apis.guru/awesome-openapi3/,我们采用了这种方法并将其应用于我们正在获取的所有 Github 项目。我们还提供原始数据作为用户以他们认为合适的方式或我们尚未想到的方式“切片和切块”的一种方式。

源数据的获取和整合由一个用 Node.js 编写的构建过程包装,该过程在 Github Actions 上运行并每天收集新数据。数据收集过程本身并没有与给定的数据源绑定。在我们 源代码库 中,我们实现了“处理器”的概念,这些处理器针对给定的源进行定制,然后将数据规范化为注册表格式。作为此过程的一部分,使用贝叶斯方法对不同的工具进行分类,然后尝试将工具放入正确的“桶”中。

目前的代码库只是一个初步版本。还有更多工作要做,问题列表 目前专注于提高数据质量、创建更好的类别以及以各种格式提供数据。还可以利用这些数据进行用户推广,将其用作参与工具,鼓励他们描述自己的需求并将工具推进到 OpenAPI 的最新版本。还可以将不同规范语言(GraphQL、Async API、JSON Schema 等)的工具数据整合在一起,以获得对 API 生态系统的更全面了解,并了解跨规范工具可能带来的好处。
一如既往,欢迎反馈。如果您有任何改进建议,请在 代码库上提出,或者如果您想详细讨论实施的任何方面,请联系我们。


OpenAPI 资源

要了解有关参与 OpenAPI 规范演进的更多信息:https://www.openapis.org.cn/participate/how-to-contribute

关于 OpenAPI Initiative

OpenAPI Initiative (OAI) 由一群有远见的行业专家创建,他们认识到标准化 API 描述方式的巨大价值。作为 Linux 基金会下属的一个开放治理结构,OAI 专注于创建、发展和推广一种供应商中立的描述格式。OpenAPI 规范最初基于 Swagger 规范,由 SmartBear Software 捐赠。要参与 OpenAPI Initiative,请访问 https://www.openapis.org.cn

关于 Linux 基金会

Linux 基金会成立于 2000 年,拥有 1000 多名成员的支持,是全球领先的开源软件、开放标准、开放数据和开放硬件协作中心。Linux、Kubernetes、Node.js 等 Linux 基金会项目被认为对世界上最重要的基础设施的开发至关重要。其开发方法利用既定的最佳实践,并满足贡献者、用户和解决方案提供商的需求,以创建可持续的开放协作模式。有关更多信息,请访问 linuxfoundation.org。