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、第一資本GoogleIBMIntuit微軟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].