跳至主要内容
搜索
类别

新闻

十二月 04
喜欢0

OpenAPI 月球漫步 2024

作者 公告, 博客, 新闻

一名宇航员在月球上插了一面带有 OpenAPI 标识的旗帜。OpenAPI 规范的下一步是什么？v4 如何才能在 OpenAPI v3 的成功基础上再接再厉？规范如何在人工智能和大型语言模型的背景下帮助解决问题？

随着 2023 年接近尾声，这些问题的答案开始成形。我们雄心勃勃地目标是 **在 2024 年底推出 v4 "月球漫步"**，这将是令人激动的一年。

由于任务艰巨，因此有必要确立一些指导原则。在回顾了去年提出的主要方案和讨论后，这些原则是 **语义**、**签名**、**包容性**、**组织**、**升级**，它们的顺序十分重要

    1. **🌖 语义提供目的**。仅仅描述 API 的机制是不够的，还必须描述其语义，无论消费者是人还是人工智能。语义将 **什么** *(...这有什么用？)* 和 **为什么** *(...这有什么意义？)* 与 **如何** *(...这怎么运作？)* 结合起来。

      OpenAPI 帮助人们更快地构建更好的 API，而工具生态系统持续年复一年地创造更多价值。2023 年的新事物是新型 API 消费者 - 生成式人工智能的兴起。大型语言模型可以处理 OpenAPI 描述，然后利用该 API 解决问题。凭借生成式人工智能理解自然语言的能力，OpenAPI 可以帮助将 API 的强大功能带给非开发人员，实现前所未有的可访问性水平。为了充分实现这种潜力，API 生产者应该在其 HTTP 请求的机械描述中添加传达这些 API 操作的含义和目的的详细信息。这反过来也有助于人和大型语言模型获得更好的结果。

      换句话说，人们几个世纪以来一直在用松散的自然语言相互交流，而我们几十年来一直在使用严格的编程语言与机器交流。大型语言模型弥合了松散和严格的世界之间的差距，这意味着大量以前无法使用 API 的人现在可以使用了。

      无论您对生成式人工智能抱有什么看法，从过度炒作到改变世界，我们都可以预料到许多人将使用 OpenAPI 来驱动基于人工智能的 API 消费者。如果 OpenAPI 不提升自身来满足该社区的需求，他们就会寻找替代方案。

    2. **🌒 请签名！** API 代表一组函数，每个函数描述一个面向客户端的目的。函数可以通过其签名识别，该签名与一组 HTTP 交互相关联。月球漫步将这一概念置于其核心地位。

      任何 HTTP API 始终都是达到某种目的的手段。API 消费者更喜欢重用现有功能，理想情况下，他们可以以最自然的方式了解该功能。PUT/PATCH/DELETE 返回 200 或 204 是一个实现细节，与它对客户端执行的功能相比相形见绌。如今，在 OpenAPI 中表达 API 函数签名的途径有限。pathItem 无法使用查询参数来区分操作。每个 HTTP 方法只能有一个操作。这些是由于缺乏对唯一签名的正式定义而对 API 函数签名施加的人为约束。OpenAPI 过去的工作重点是使开发人员能够描述 HTTP API。这重新排列了优先级，以便开发人员可以使用 OpenAPI 来定义具有唯一签名的 API 函数，然后将每个签名映射到 HTTP 机制。

    1. **🌕 包容性需要一个大帐篷**：月球漫步旨在描述所有基于 HTTP 的 API。虽然它在 HTTP API 的设计方面保持中立，但它认识到拥有不同的设计风格和意见的重要性。

      月球漫步应该能够描述开发人员可能已经拥有的 HTTP API，以及他们可能想要构建的 API。它应该能够将 API 函数的签名准确地映射到 API 提供的 HTTP 请求和响应的实际实例。月球漫步确实更倾向于面向资源的 API 风格，因为它们非常流行，但它应该能够描述纯粹的 RPC API，即使这些 API 签名是通过 HTTP 标头值或请求正文值来区分的。

    1. **🌗 通过关注点分离进行组织**。例如，API 的形状变化应该独立于 API 部署进行。API 部署可以使用不同的安全方案进行保护。API 函数的签名不应该与内容模式格式紧密耦合。

      为了满足不断增长的客户群的各种需求，功能数量无疑会增加，从而带来更多复杂性。为了抵消这种影响，我们将对 API 描述不同方面的模块化应用更多严格性。我们将努力消除当前存在的歧义，并利用现有标准来最大程度地减少不必要的创新。我们的目标是为 API 描述消费者、作者和工具提供者提供更好的体验。

    1. **🌑 机械升级**。OpenAPI v3 的一个重要原则是它提供了从 v2 的直接升级路径。月球漫步继承了这一点，这意味着它必须再次能够从 v3（以及 v2）机械地升级到月球漫步。

像 OpenAPI 这样的重要开源项目依赖于许多人的贡献。如果您像我们一样对上述想法或利用人工智能帮助更多人使用 API 的机会感到兴奋，请参与进来！一个很好的起点是加入我们每周四的电话会议（详情），欢迎任何想加入的人！

 

三月 08
喜欢0

支持 OpenAPI 规范的工具

作者 博客, 新闻

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

介绍我们的 OpenAPI 工具注册表。注册表在 https://tools.openapis.org.cn 上公开了一个基于“经典”UI 的注册表，该注册表使用从现有注册表自动获取的数据，并使用从（作为第一个剪切）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 软件公司捐赠。要参与 OpenAPI Initiative，请访问 https://www.openapis.org.cn

关于 Linux 基金会

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

2 月 24 日
喜欢0

开发者：API 对业务至关重要，但难以做好

作者 新闻

一项针对 API 开发者的调查表明，安全性、客户满意度和部署速度是最大的挑战之一
API 至关重要，不提供 API 意味着您的软件或服务将失去关键受众。但由于工具不集成、安全问题以及难以快速迭代和解决问题，API 的开发过程非常困难。

这些见解以及其他见解是 API 测试和工具公司 Smartbear 本周发布的“API 状态调查报告 2016”的一部分。该报告汇集了来自 104 个国家/地区的 2300 多名开发者的调查结果，涵盖了四个主要类别：技术和工具、开发和交付、质量和性能以及使用和消费。

[阅读 InfoWorld 上的完整文章]

2 月 18 日
喜欢0

Developer.aero 通过 3Scale 平台采用新的 Open API 定义格式

作者 新闻

我们很高兴与最新的全球 API 标准倡议合作，该倡议由一个新组织 OAI（Open API Initiative）推动。这个非营利组织旨在创建一个新的、更正式的 Web API 描述格式，暂定名为 OADF（Open API Description Format）。

该倡议希望创建一个开放的技术社区，社区成员可以轻松地为构建供应商中立、可移植和开放的规范做出贡献，该规范将扩展现有的 Swagger 规范，以提供 RESTful API 的元数据。

Developer.aero 平台目前使用 Swagger 规范，未来将采用新的 OADF 规范，并将自动更新到最新版本。

[阅读 developer.aero 上的完整文章]

1 月 7 日
喜欢0

关于 Open API Initiative 和最新 Swagger 新闻的 Tony Tam 访谈

作者 新闻

在 Linux 基金会于 11 月初宣布成立 Open API Initiative (OAI) 并公布了令人印象深刻的创始成员名单后，API 开发者对 OAI 在推动标准共识方面的作用提出了疑问。

Swagger 项目创始人 Tony Tam 于 11 月底在德克萨斯州奥斯汀举行的 API 战略与实践大会上回答了其中一些问题。InfoQ 在大会上会见了 Tony，以深入了解我们认为读者想要问的问题。

InfoQ：您能详细谈谈您在 SmartBear 的新角色以及您最近决定加入他们的原因吗？

[阅读 InfoQ 上的完整文章]

11 月 10 日
喜欢0

开源项目促进基于 RESTful API 的开发

作者 新闻

正在出现一些开源项目，以进一步推动基于 RESTful API 的软件开发实践，RESTful API 在提供应用程序后端服务和其他功能方面越来越重要。

为了建立 REST API 描述标准和指南，SmartBear 软件公司最近在 Linux 基金会的管理下启动了一个名为 Open API Initiative(OAI) 的开源项目。与此同时，其他供应商也在开源他们自己的本土 API 项目，例如 DreamFactory Software Inc. 为移动、Web 和物联网 (IoT) 应用程序提供的后端。

[阅读 ADTMag 上的完整故事]

11 月 5 日
喜欢0

IBM 与 Yes Bank、Bian 合作推动 API 经济发展

作者 新闻

IBM (NYSE: IBM) 今天宣布推出 API Harmony，这是一款面向开发者的智能云 API 配对技术，作为一系列技术、产品和服务公告的一部分，旨在推动不断发展的 API 经济。

API Harmony 提供独特的开发者体验，利用机器学习和图技术等认知技术来预测开发者构建新应用程序所需的内容，推荐使用哪些 API，显示 API 关系，以及识别缺少的内容。

API 经济 – 将商业功能、能力或技能作为打包在 API 中的服务进行商业交换 – 是当今各个行业数字转型的驱动力，使企业领导者能够转型其组织，构建新的生态系统并将其核心资产、服务和产品货币化。预计到 2018 年，API 经济将成为一个 2.2 万亿美元的市场。1 根据 IT 研究和咨询公司 Ovum 的预测，未来两到三年，拥有 API 程序的企业数量预计将增长 150%。
[在 FinExtra.com 上阅读完整文章]

11 月 5 日
喜欢0

新的协作项目，扩展 Swagger 规范，以构建互联应用程序和服务

作者 新闻

旧金山，加利福尼亚州 – (Marketwired – 2015 年 11 月 5 日) – 致力于加速 Linux 和协作开发的非营利组织 Linux 基金会今天宣布推出 Open API Initiative。Open API Initiative 的创始成员包括 3Scale、Apigee、Capital One、Google、IBM、Intuit、Microsoft、PayPal、Restlet 和 SmartBear。

该倡议将扩展 Swagger 规范和格式，以创建一个开放的技术社区，社区成员可以轻松地为构建供应商中立、可移植和开放的规范做出贡献，该规范用于提供 RESTful API 的元数据。这种开放规范将使人和计算机都能以最少的实现逻辑来发现和理解相应服务的 capabilities。该倡议还将推广和促进开放 API 标准的采用和使用。

“Swagger 被认为是构建 API 最流行的框架之一。当一个开源项目达到这种成熟度时，它就不可能由一家公司、组织或开发者管理，”Linux 基金会执行董事 Jim Zemlin 说。“Open API Initiative 将扩展这项技术，通过开放标准促进互联应用程序开发。”

[在路透社上阅读完整文章]

关闭菜单