OpenAPI 规范 3.0 版接近最终发布

  • Abel Avram
  • Rays

2017 年 2 月 3 日

话题:开源语言 & 开发

“开放 API 战略”(Open API Initiativev) 发布了 OpenAPI 规范 3.0 版的预览,并规划于今年二月底发布实施草案(Implementer Draft)。

新的OpenAPI 规范 3.0带来了如下重大改进

  • 为实现更好的可重用性,对规范的整体架构进行了重构,重构后的架构如下图所示。
  • 支持 oneOf、anyOf 和 not 的 JSON 模式。
  • 可使用模式的参数。
  • 引入了 Cookie 参数,去除了 dataForm 参数。
  • 具有自身实体的主体参数(Body Parameter)。
  • 可协商的内容类型。
  • 多主机支持。
  • 简化了安全定义,改进的 WebHooks 不再通过回调机制描述。

“开放 API 战略”作为负责规范开发的组织,计划在今年二月底前给出首个实施草案。

已公布的 OpenAPI 规范目标是:

定义标准的、独立于语言的指向 REST API 的接口,使得服务能力无需访问源代码、文档,或是借助于网络流量检查,就可被人类和计算机发现并理解。通过对 OpenAPI 做适当定义后,消费者可使用最小数量的实现逻辑理解远程服务,并与远程服务交互。

OpenAPI 基于 Swagger 2.0 构建,Swagger 是 SmartBear 贡献给 Linux 基金会的。意在构建具有中立管理模型的新组织,以引领 Swagger 更上一层楼。“开放 API 战略”的创始成员包括对贡献具有兴趣的 Google、IBM 和 Microsoft。同时还成立了一个技术开发者社区(TDC,Technical Developer Community)以对规范做开发。TDC 对于任何有意向做出贡献的个人都是开放的,无需会员身份。

在对“上百个任务单和上千条评论”近一年的处理工作后,现在 OpenAPI 规范已接近于最终发布,不会再有任何其他重大改进。

查看英文原文:The OpenAPI Spec Reaches 3.0


感谢刘志勇对本文的审校。

给 InfoQ 中文站投稿或者参与内容翻译工作,请邮件至editors@cn.infoq.com。也欢迎大家通过新浪微博(@InfoQ@丁晓昀),微信(微信号:InfoQChina)关注我们。

开源语言 & 开发