OpenAPI Specification: Difference between revisions

Revision as of 16:05, 7 November 2023

Revision as of 21:29, 27 November 2023

Line 28:

| website = {{URL|openapis.org}}

}}

The '''OpenAPI Specification''', previously known as the '''Swagger Specification''', is a [[Specification (technical standard)|specification]] for a [[Machine-readable medium|machine-readable]] [[interface definition language]] for describing, producing, consuming and visualizing [[Web API|web services]].<ref>{{Cite web|url=httphttps://www.businesscloudnewslinuxfoundation.comorg/2015press/11press-release/06/linuxnew-foundationcollaborative-wantsproject-to-extend-swagger-inspecification-for-building-connected-buildings/applications-and-services|title=LinuxNew FoundationCollaborative wantsProject to extendExtend Swagger inSpecification connectedfor buildingsBuilding {{!}}Connected BusinessApplications Cloudand NewsServices|archive-url=https://web.archive.org/web/2016050623510820231031170437/httphttps://www.businesscloudnewslinuxfoundation.comorg/2015press/11/06press-release/linuxnew-foundationcollaborative-wantsproject-to-extend-swagger-inspecification-for-building-connected-buildings/|access-date=2016applications-04and-22services|archive-date=631 MayOctober 20162023}}</ref> Previously part of the [[Swagger (software)|Swagger]] framework, it became a separate project in 20162015, overseen by the OpenAPI Initiative, an open-source collaboration project of the [[Linux Foundation]].<ref name="charter">{{cite web |title=OpenAPI Initiative Charter |url=https://www.openapis.org/participate/how-to-contribute/governance |website=OpenAPI Initiative |access-date=12 November 2019}}</ref>

ByAn takingOpenAPI asdocument anrepresents inputa swaggerformal anddescription someof otheran API that tools can use to generate code, documentation, and test cases, from OpenAPI Specification compliantand filesmore.

==History==

[[Swagger (software)|Swagger]] development began in early 2010 by Tony Tam, who was working at online dictionary company [[Wordnik]].<ref>{{cite web|url=https://sdtimes.com/apis/swagger-creator-joins-smartbear/|title=Swagger creator joins SmartBear|access-date=August 6, 2019}}</ref>

In March 2015, [[SmartBear Software]] acquired the open-source Swagger API specification from Reverb Technologies, Wordnik's parent company.<ref>{{Cite web|title = SmartBear Assumes Sponsorship of Swagger API Open Source Project|url=https://smartbear.com/news/news-releases/sponsorship-of-swagger/|website = SmartBear|access-date = 2015-03-25}}</ref>

In November 2015, SmartBear announced that it was creating a new organization called the OpenAPI Initiative under the sponsorship of the [[Linux Foundation]]. Other founding member companies included [[3scale]], [[Apigee]], [[Capital One]], [[Google]], [[IBM]], [[Intuit]], [[Microsoft]], [[PayPal]], and Restlet.<ref name="faqs">{{cite web |title=FAQ |url=https://www.openapis.org/faq#OAIFAQ-History |website=OpenAPI Initiative |access-date=12 November 2019}}</ref><ref>{{Cite news|url=http://www.programmableweb.com/news/%E2%80%8Bsmartbear-linux-foundation-launch-open-api-initiative-to-evolve-swagger/2015/11/10|title=SmartBear, Linux Foundation launch Open API Initiative to Evolve Swagger|date=2015-11-10|work=ProgrammableWeb|access-date=2016-04-21}}</ref><ref>{{Cite web|url=http://www.linuxfoundation.org/news-media/announcements/2015/11/new-collaborative-project-extend-swagger-specification-building|title=New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services|website=linuxfoundation.org|access-date=2016-04-22|url-status=dead|archive-url=https://web.archive.org/web/20160427104213/http://www.linuxfoundation.org/news-media/announcements/2015/11/new-collaborative-project-extend-swagger-specification-building|archive-date=2016-04-27}}</ref> SmartBear donated the Swagger specification to the new group. [[RAML (software)|RAML]] and [[API]] Blueprint were also under consideration by the group.<ref>{{Cite web|url=http://www.infoworld.com/article/3014506/apis/in-2016-the-need-for-an-api-meta-language-will-crystallize.html|title=In 2016, the need for an API meta-language will crystallize|last=Montcheuil|first=Yves de|website=InfoWorld|access-date=2016-04-25}}</ref><ref>{{Cite web|url=http://www.infoq.com/news/2016/04/Amazon-API-Gateway-Swagger|title=Amazon API Gateway Now Supports Swagger Definition Import|website=InfoQ|access-date=2016-04-25}}</ref>

On 1 January 2016, the Swagger specification was renamed the OpenAPI Specification (OAS) and was moved to a new [[GitHub]] [[Software repository|repository]].<ref>{{cite web |last1=OpenAPI Initiative |title=OpenAPI Specification |url=https://github.com/OAI/OpenAPI-Specification |website=GitHub |access-date=12 November 2019}}</ref>

In September 2016, the API World conference presented an API Infrastructure award to SmartBear for its ongoing work on Swagger.<ref>{{Cite web|url=https://swagger.io/blog/api-development/swagger-wins-the-2016-api-award-for-api-infrastruc/|title=Swagger wins the 2016 API Award for API Infrastructure|website=Swagger Blog|access-date=2018-07-27}}</ref>

In July 2017, the OpenAPI Initiative released version 3.0.0 of its specification.<ref>{{Cite web|url=https://www.openapis.org/blog/2017/07/26/the-oai-announces-the-openapi-specification-3-0-0|title=The OAI Announces the OpenAPI Specification 3.0.0|website=OpenAPIs|access-date=2018-04-19}}</ref> [[MuleSoft]], the main contributor to the alternative [[RESTful API Modeling Language]] (RAML), joined the OAS and open-sourced its API Modeling Framework tool, which can generate OAS documents from RAML input.<ref>{{Cite web|url=https://www.infoq.com/news/2017/05/api-raml-oas|title=The HTTP API space is Consolidating around OAS|website=InfoQ|access-date=2017-05-14}}</ref>