维基百科

OpenAPI规范

描述 API 格式的语言规格

OpenAPI规范（英语：OpenAPI Specification, OAS），原称Swagger规范，是种机器可读的接口描述语言规范以描述、生成、使用和可视化Web服务。 [1] 原先，是Swagger框架的一部分，2015年成为独立项目，由Linux基金会的开源合作项目OpenAPI Initiative监督。 [2] [3]

OpenAPI
OpenAPI Specification
开始年2010年 (2010)
首次出版2011年8月10日 (2011-08-10)
最新版本3.1.0
2021年2月15日 (2021-02-15)
网站openapis.org

OpenAPI 描述 (OAD) [4]表示 API 的正式描述，机器可以依此生成代码、文档、测试用例等。OpenAPI 计划每年赞助一次 API 规范会议 (ASC)。该活动起源于举办多年的 API 战略与实践会议 (APIStrat)，并于 2016 年成为 OpenAPI 计划的一部分。

历史

编辑

2010年初，在线词典公司Wordnik工作的Tony Tam开发Swagger。 [5]

2015年3月， SmartBear Software自Wordnik 的母公司 Reverb Technologies手上收购开源的Swagger API规范。 [6]

2015年11月，SmartBear将Swagger 规范捐献给Linux基金会赞助的OpenAPI Initiative。其他创始成员包括3scale、Apigee、第一资本、Google、IBM、Intuit、微软、PayPal和Restlet。[7][8]

2016年1月1日，Swagger规范更名为OpenAPI规范（OAS），并移至新的GitHub目录。 [9]

2017年7月，OpenAPI 计划发布了规范的 3.0.0 版本。 [10] MuleSoft是替代RESTful API 建模语言(RAML) 的主要贡献者，加入OpenAPI规范，开源其API建模框架工具。该工具可以将RAML输入转换生成OAS文档。 [11]

发布日期

编辑
版本 日期 注释[12]
3.1.0 2021-02-15 OpenAPI 规范 3.1.0 发布
3.0.3 2020-02-20 OpenAPI 规范 3.0.3 补丁版本
3.0.2 2018-10-08 OpenAPI 规范 3.0.2 补丁版本
3.0.1 2017-12-06 OpenAPI 规范 3.0.1 补丁版本
3.0.0 2017-07-26 OpenAPI 规范 3.0.0 发布
2.0 2014-09-08 Swagger 2.0 发布
1.2 2014-03-14 正式文件的首次发布
1.1 2012-08-22 Swagger 1.1 发布
1.0 2011-08-10 Swagger 规范的首个版本


特征

编辑

OpenAPI 规范与语言无关。借助 OpenAPI 的宣告式资源规范，客户端无需了解伺服器实现或访问伺服器代码即可理解和使用服务。 [1]

参见

编辑

参考

编辑
  1. ^ 1.0 1.1 OpenAPI Documentation: Getting Started. Learn OpenAPI. The OpenAPI Initiative. [2024-09-17]. 
  2. ^ New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services. （原始内容存档于31 October 2023）. 
  3. ^ OpenAPI Initiative Charter. OpenAPI Initiative. [12 November 2019]. 
  4. ^ OpenAPI Documentation: Glossary. Learn OpenAPI. The OpenAPI Initiative. 2023 [2024-09-17]. 
  5. ^ Swagger creator joins SmartBear. [August 6, 2019]. 
  6. ^ SmartBear Assumes Sponsorship of Swagger API Open Source Project. SmartBear. [2015-03-25]. 
  7. ^ FAQ. OpenAPI Initiative. [12 November 2019]. 
  8. ^ New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services. linuxfoundation.org. [2016-04-22]. （原始内容存档于2016-04-27）. 
  9. ^ OpenAPI Initiative. OpenAPI Specification. GitHub. [12 November 2019]. 
  10. ^ The OAI Announces the OpenAPI Specification 3.0.0. OpenAPIs. July 26, 2017 [2018-04-19]. 
  11. ^ Avram, Abel. The HTTP API space is Consolidating around OAS. InfoQ. May 6, 2017 [2017-05-14]. 
  12. ^ OpenAPI Specification Version 3.1.0. GitHub. [November 7, 2023]. 
检索自“https://zh.wikipedia.org/w/index.php?title=OpenAPI規格&oldid=84384953”