跳至主要内容
搜索

常见问题

什么是 OpenAPI？

存在 OpenAPI 规范 (OAS)，一种描述某些 API 的技术规范，以及 OpenAPI 计划 (OAI)，一个使 OAS 等规范蓬勃发展的组织。

OAS 为 REST API 定义了一种标准的、与编程语言无关的接口描述，它允许人和计算机在无需访问源代码、其他文档或检查网络流量的情况下发现和理解服务的 capabilities。当通过 OAS 正确定义时，消费者可以使用最少的实现逻辑来理解和交互远程服务。类似于接口描述对较低级别编程的作用，OAS 消除了调用服务的猜测。

OpenAPI 计划 (OAI) 由一群具有前瞻性的行业专家创建，他们认识到标准化 API 描述方式的巨大价值。作为 Linux 基金会下的一种开放治理结构，OAI 专注于创建、发展和推广一种供应商中立的描述格式。OpenAPI 规范基于重命名的 Swagger 2.0 规范，该规范由 SmartBear Software 于 2015 年捐赠。 

什么是 ASC？

OpenAPI 计划每年都会赞助 API 规范大会 (ASC)。如果您有兴趣开发、管理、销售或使用 API，那么这个大会就是为您准备的。

OpenAPI 规范 (OAS)、RAML、Blueprint、gRPC、OData、JSON Schema、GraphQL、AsynchAPI 和其他格式都将成为本次活动的话题，使与会者能够熟悉这些格式并讨论如何在实践中使用它们。

该活动起源于 API 策略与实践大会 (APIStrat)，该大会举办了许多年，并于 2016 年成为 OpenAPI 计划的一部分。APIStrat 的协作精神和社区通过 ASC 活动得以延续，我们期待着许多同样的生动对话和辩论！

来自 2021 年 和 2020 年 的往期演讲可在我们的 YouTube 频道上观看。 2022 年的演讲在此处提供！

OpenAPI 规范 3.1.0 什么时候可用？

现在就可以使用了！它已于 2021 年 2 月 16 日完成并发布。这个最新版本支持与最新草案 (2020-12) 的 JSON Schema 100% 兼容。

阅读 公告 或直接转到 官方 OpenAPI 存储库。

随着此版本的发布，OpenAPI 计划赞助了新文档的创建，以便更容易理解规范的结构及其优势。它在此处提供：https://oai.github.io/Documentation/

有关 从 3.0 迁移到 3.1.0 的信息 也在此处提供。

OpenAPI 规范与 Swagger 有什么区别？

OpenAPI 规范（又名规范）最初基于 Swagger 规范，由 SmartBear Software 捐赠。规范捐赠后，于 2016 年成为一个独立的项目，由 OpenAPI 计划（Linux 基金会的一个开源协作项目）监督。有关规范历史的更详细（尽管不是“官方”）概述，请参阅 “连接系统和亚文化：Swagger 起源故事”

OpenAPI 规范与 GraphQL 有什么区别？

螺丝钉比钉子好在哪里？两者都是有用的工具，以略微不同的方式解决类似的问题。OpenAPI 规范提供了一个声明性契约，该契约定义了 API 请求和响应的结构作为离散操作。GraphQL 更喜欢一种类似于查询数据库的接口样式，并且最适合图数据库。 

OpenAPI 和 GraphQL 都是 Linux 基金会项目。

在哪里可以获取 OpenAPI 规范？

要阅读规范，您可以从 最新文档 开始。

要参与 OpenAPI 规范的持续发展，请访问 GitHub 上的项目。 

OpenAPI 规范的主要优势是什么？

业务优势包括

  • OpenAPI 规范 (OAS) 背后是一个令人印象深刻的行业领导者群体，代表着行业中强大的认知度和关注度。 
  • OAS 被广泛认为是最流行的用于定义和创建 RESTful API 的开源框架，如今数以万计的开发人员正在构建数千个利用 OAS 的开源工具存储库。 
  • 这种广泛的行业支持也强烈表明了当今庞大而多样化的代码库的稳定性，并预示着光明的前景。

技术优势包括

  • 借助 OAS 的声明性资源规范，客户端可以理解和使用服务，而无需了解服务器实现或访问服务器代码。
  • OAS 与语言无关。
  • OAS 拥有出色的文档、支持和参与社区的个人专家。OAS 不仅拥有广泛的行业支持，而且拥有悠久的历史，拥有庞大、充满活力、才华横溢的社区和支持基础。有很多方法可以与才华横溢的个人联系，以查找示例实现、代码片段和具体答案。

谁创立了 OpenAPI 计划，当前成员有哪些？

2015 年 11 月，SmartBear、3Scale、Apigee、Capital One、Google、IBM、Intuit、Microsoft、PayPal 和 Restlet 宣布成立 OpenAPI 计划 (OAI)，作为 Linux 基金会下的一个开源项目。 

如今，该计划包括来自广泛的行业领导者群体中的 40 多个成员。请参阅 当前完整的成员列表。 

如何加入？

如果您已准备好 立即加入！如果您还有其他问题，请填写 会员咨询 表格（不到 3 分钟），以便安排电话来解答您的问题！

是否需要成为成员才能参与？

欢迎所有人参与。要加入对话

主要行动发生在 https://github.com/OAI/OpenAPI-Specification 。

注册通知 以获取每周在 Zoom 上进行的讨论。

使用 公共自助邀请链接 加入我们的 Slack 工作区。

您是否有任何特别兴趣小组 (SIG)，如何了解更多信息？

我们肯定有 SIG，我们鼓励您加入！

如何提交博客文章？

OpenAPI 博客作为成员和整个社区的渠道，向广大受众广播您的工作和参与如何为 OpenAPI 计划和 OAS（OpenAPI 规范）创造更多机会。已接受的博客文章由 OpenAPI 计划自行决定，有关指南，请参阅此处。

我有一个问题，我不确定该问谁或在哪里问？

我们很乐意在 [email protected] 听到您的声音。

关闭菜单