Content deleted Content added
Levinda987 (talk | contribs) Clarified what an OpenAPI spec is. Tags: Mobile edit Mobile app edit iOS app edit |
Rescuing 1 sources and tagging 0 as dead.) #IABot (v2.0.9.5 |
||
| (42 intermediate revisions by 27 users not shown) | |||
Line 1:
{{Short description|A specification for machine-readable interface files}}
{{Infobox technology standard
| title = OpenAPI
| long_name = OpenAPI Specification
| image = OpenAPI Specification Logo Pantone.svg
| image_size =
| alt =
| caption =
| abbreviation =
| native_name = <!-- Name in local language. If more than one, separate using {{plain list}} -->
| native_name_lang = <!-- ISO 639-1 code e.g. "fr" for French. If more than one, use {{lang}} inside native_name items instead -->
| status =
| year_started = {{Start date|2010}}
| first_published = {{Start date|2011|08|10|df=y}}
| version = 3.1.1
| version_date = {{Start date|2024|10|24|df=y}}
| preview =
| preview_date =
| organization =
| committee =
| editors =
| authors =
| base_standards =
| related_standards =
| ___domain =
| license =
| copyright =
| website = {{URL|https://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 name=started>{{cite web |title=OpenAPI Documentation: Getting Started |website=Learn OpenAPI |url=https://learn.openapis.org/ |publisher=The OpenAPI Initiative |access-date=2024-09-17}}</ref> Originally developed to support the [[Swagger (software)|Swagger]] framework, it became a separate project in 2015, overseen by the OpenAPI Initiative, an open-source collaboration project of the [[Linux Foundation]].<ref>{{Cite web|url=https://www.linuxfoundation.org/press/press-release/new-collaborative-project-to-extend-swagger-specification-for-building-connected-applications-and-services|title=New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services|archive-url=https://web.archive.org/web/20231031170437/https://www.linuxfoundation.org/press/press-release/new-collaborative-project-to-extend-swagger-specification-for-building-connected-applications-and-services|archive-date=31 October 2023}}</ref><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 |archive-date=26 January 2025 |archive-url=https://web.archive.org/web/20250126133749/https://www.openapis.org/participate/how-to-contribute/governance |url-status=dead }}</ref>
An OpenAPI Description (OAD)<ref name=glossary>{{cite web|title=OpenAPI Documentation: Glossary |website=Learn OpenAPI |url=https://learn.openapis.org/glossary.html |publisher=The OpenAPI Initiative |date=2023 |access-date=2024-09-17}}</ref> represents a formal description of an API that tools can use to generate code, documentation, test cases, and more.
==History==
[[File:OpenAPI Logo Pantone.svg|thumb|Logo of the OpenAPI Initiative, the organization that develops the OpenAPI specification under the [[Linux Foundation]]]]
[[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|date=28 September 2015 |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
In November 2015, SmartBear announced that it was
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
In
===Consolidation of Formats===
Two somewhat similar technologies, [[MuleSoft]]'s [[RESTful API Modeling Language]] (RAML) and Apiary's API Blueprint, had been developed around the same time as what was then still called the Swagger Specification.
==Release dates==▼
The producers of both formats later joined the OpenAPI Initiative: Apiary in 2016<ref>{{cite web|url=https://www.openapis.org/blog/2016/02/23/oai-update-new-members-openapi-spec-3-0-progress-and-more |website=The OpenAPI Initiative|title=OAI Update – new members, OpenAPI Spec 3.0 progress, and more!|last=Lensmar |first=Ole |date=23 February 2016 |accessdate=13 October 2024}}</ref> and MuleSoft in 2017.<ref name=RAML>{{Cite web|url=https://www.infoq.com/news/2017/05/api-raml-oas |first1=Abel |last1=Avram |date=May 6, 2017 |title=The HTTP API space is Consolidating around OAS|website=InfoQ|access-date=2017-05-14}}</ref> Both have added support for the OAS.<ref>{{cite web|url=https://blog.apiary.io/We-ve-got-Swagger |website=Oracle Apiary |title=We've got Swagger|last=Nesetril |first=Jakub |date=18 January 2016 |accessdate=13 October 2024}}</ref><ref name=RAML />
▲===Release dates===
{| class="wikitable"
|-
! Version !! Date !! Notes<ref>{{cite web|url=
|-
|3.1.1
|2024-10-24
|Patch release of the OpenAPI Specification 3.1.1
|-
| 3.1.0 || 2021-02-15 || Release of the OpenAPI Specification 3.1.0
|-
|3.0.4
|2024-10-24
|Patch release of the OpenAPI Specification 3.0.4
|-
|3.0.3
Line 49 ⟶ 92:
==Usage==
The OAS describes the format for OpenAPI Descriptions (OADs),<ref name=glossary /> which can be used by a variety of applications, libraries, and tools.
Applications implemented based on OpenAPI interface files can automatically generate documentation of methods, parameters and models. This helps keep the [[Software documentation|documentation]], client libraries and source code in sync.<ref name=git>{{Cite web|title = swagger-api/swagger-spec|url = https://github.com/swagger-api/swagger-spec/wiki|website = GitHub|access-date = 2015-12-01}}</ref>▼
▲Applications
When an OAD is used to generate source code stubs for servers, the process is called [[Scaffold (programming)|scaffolding]].
===Relationships to software engineering practices===
The paradigm of agreeing on an API contract first and then programming business logic afterwards, in contrast to coding the program first and then writing a retrospective description of its behavior as the contract, is called contract-first development. Since the interface is determined before any code is written, downstream developers can [[Mock object|mock]] the [[Server (computing)|server]] behavior and start testing right away.<ref>{{Cite book |last=Preibisch |first=Sascha |publisher=Apress |title=API Development: A Practical Guide for Business Implementation Success |date=2018 |isbn=978-1-4842-4140-0 |___location=[Berkeley, CA] |oclc=1076234393 |quote=Having the Swagger (or for that matter, any other machine-readable) document available, team members can start working on their part of the project at the same time.}}</ref> In this sense, contract-first development is also a practice of [[shift-left testing]].
==Features==
The OpenAPI Specification is language-agnostic. With OpenAPI's [[Declarative programming|declarative]] resource specification, clients can understand and consume services without knowledge of server implementation or access to the server code.<ref name=
==Tools that work with OpenAPI==
The OpenAPI Initiative maintains a list of implementations for version 3.0 of the specification.<ref>{{cite
==Annual conference==
The OpenAPI Initiative sponsors an annual API Specifications Conference (ASC). The event has its origins in the API Strategy and Practice Conference (APIStrat) that ran for many years and became part of the OpenAPI Initiative in 2016.
==See also==
* [[Representational state transfer
* [[gRPC]]
* [[Data modeling|Data modelling]]
==References==
Line 78 ⟶ 127:
* [https://openapis.org/ OpenAPI Initiative (OAI) website]
* [https://events.linuxfoundation.org/openapi-asc/ API Specifications Conference (ASC) website]
* [https://github.com/OAI/OpenAPI-Specification OpenAPI Specification on GitHub]
* [https://github.com/APIs-guru/openapi-directory/ Directory of OpenAPI
* [https://learn.openapis.org/examples/ Example OpenAPI Descriptions on the OAI's official Learn OpenAPIs site]
{{Use dmy dates|date=April 2019}}
{{Linux Foundation}}
[[Category:Software architecture]]
[[Category:Application programming interfaces]]
[[Category:Markup languages]]
[[Category:JSON]]
| |||