跳至主要内容

您可以参与创建 OpenAPI 规范,以下是方法

作者: 2016 年 7 月 11 日2017 年 6 月 5 日博客

OpenAPI 规范是如何演变的?流程是什么?您如何参与?今天我们将尝试回答这些问题,并重点介绍

  • 技术开发者社区,其存在原因和运作方式
  • OpenAPI 规范下一个主要版本的发布时间表和路线图

Open API Logo

去年 12 月,Swagger 2.0 规范由 SmartBear 捐赠,并成为 OpenAPI 规范(有时缩写为 OAS)。该规范与之前完全兼容,只是名称和品牌有所不同。为什么这很重要?在某种程度上,它并不重要——之前并没有什么“错误”。但是,为了让一些具有竞争力的供应商将对该格式的支持构建到其产品中并就行业标准进行协作,他们需要一个中立的治理模式。这正是 Open API Initiative 在 Linux 基金会下创建的原因,以便发展以前被称为 Swagger 规范的规范。

_meta_issue_specification_documentation_structure_and_supporting_docs_issue_589_oai_openapi-specificationOpen API Initiative 的章程创建了“一个开源的技术开发者社区 (TDC),对任何参与者开放,无论是 OAI 成员还是非成员”。TDC 负责监督 OpenAPI 规范的演变。如今,TDC 有六名成员,随着社区中个人成员的加入,TDC 将随着时间的推移而不断壮大。好消息是,自从 2.0 规范发布以来,社区中的人们一直在为改进规范提出建议。许多问题已被确定为下一个主要版本的候选问题——现在面临的挑战是决定下一个版本中包含哪些问题,以及将这些更改提至发布候选状态。

为了解决大量的待处理问题,Tony Tam(Swagger 的创始人,也是 TDC 的领导者)确定了一些高级主题,例如 安全协议和有效负载,添加了对各个问题的引用,然后将它们标记为 OpenAPI.Next 的元问题,位于 GitHub 上。了解 OpenAPI 规范 3.0 可能采取的方向的最佳方式是查看这些元问题。在接下来的几周内,Jason HarmonDarrel MillerMarsh Gardiner 将尝试通过单独的博客文章来分解其中的一些问题,以便解释这些问题背后的部分思路。

clarification_about_yaml_by_fehguy_pull_request_635_oai_openapi-specification虽然 TDC 努力通过问题和拉取请求进行沟通,但我们都是志愿者,抽空来做 OpenAPI 的工作。有时进行一个小时的电话会议会更快,我们每隔几周就会进行一次。此外,我们使用 OAI 的 Slack 团队来引起人们对问题或建议的注意,而 GitHub 通知无法完成这项工作。元问题中的子问题提出的更改会导致拉取请求 (PR),然后使用 对该问题进行投票。

您如何参与?如果您对某个主题特别感兴趣,请搜索现有问题并加入讨论,或者在必要时发起一个新的讨论。

其中一些主题是哲学性的,例如 OpenAPI 是一个开放世界还是封闭世界契约?其中一些主题是充满激情的,例如 根据标头支持多个请求/响应模型。其他主题深入探讨了有关 JSON-SchemaYAML 规范 的问题。在接下来的几周内,我们将在博客上发布一些关于元问题和子问题的信息,并提供有关围绕这些问题的讨论性质的一些见解。

 


Marsh Gardiner关于作者
Marsh Gardiner
关于 Marsh 的以下三个陈述中至少有两个是正确的:没有人比他更热爱 API。他是一个困在产品人员身体里的开发者。他讨厌写简介。

在 Marsh 事业的半随机漫步中,他为 EA 和 Fox 制作了电子游戏,创建了交互式学习环境,推出了一个教育性非营利组织,并在 2009 年至 2018 年的 API 战争中勇敢作战。在 Apigee,他设想了一个更好的应用程序和 API 未来。