OpenAPI Specification
| OpenAPI Specification | |
| Year started | 2010 |
|---|---|
| First published | 10 August 2011 |
| Latest version | 3.1.0 15 February 2021 |
| Website | openapis |
The OpenAPI Specification, previously known as the Swagger Specification, is a specification for a machine-readable interface definition language for describing, producing, consuming and visualizing web services.[1] Previously part of the Swagger framework, it became a separate project in 2015, overseen by the OpenAPI Initiative, an open-source collaboration project of the Linux Foundation.[2]
An OpenAPI document represents a formal description of an API that tools can use to generate code, documentation, test cases, and more.
History
[edit]Swagger development began in early 2010 by Tony Tam, who was working at online dictionary company Wordnik.[3]
In March 2015, SmartBear Software acquired the open-source Swagger API specification from Reverb Technologies, Wordnik's parent company.[4]
In November 2015, SmartBear announced that it was donating the Swagger specification to 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.[5][6]
On 1 January 2016, the Swagger specification was renamed the OpenAPI Specification (OAS) and was moved to a new GitHub repository.[7]
In July 2017, the OpenAPI Initiative released version 3.0.0 of its specification.[8] 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.[9]
In February 2021, the OpenAPI Initiative released version 3.1.0.[10] Major changes in OpenAPI Specification 3.1.0 include JSON schema vocabularies alignment, new top-level elements for describing webhooks that are registered and managed out of band, support for identifying API licenses using the standard SPDX identifier, allowance of descriptions alongside the use of schema references and a change to make the PathItems object optional to simplify creation of reusable libraries of components.[11][12][13]
Release dates
[edit]| Version | Date | Notes[14] |
|---|---|---|
| 3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0 |
| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 |
| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 |
| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 |
| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 |
| 2.0 | 2014-09-08 | Release of Swagger 2.0 |
| 1.2 | 2014-03-14 | Initial release of the formal document |
| 1.1 | 2012-08-22 | Release of Swagger 1.1 |
| 1.0 | 2011-08-10 | First release of the Swagger Specification |
Usage
[edit]Applications implemented based on OpenAPI interface files can automatically generate documentation of methods, parameters and data models. This helps keep the documentation, client libraries and source code in sync.[15]
When an OpenAPI document is used to generate source code stubs for servers, the process is called scaffolding.
Relationships to software engineering practices
[edit]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 the server behavior and start testing right away.[16] In this sense, contract-first development is also a practice of shift-left testing.
Features
[edit]The OpenAPI Specification is language-agnostic. With OpenAPI's declarative resource specification, clients can understand and consume services without knowledge of server implementation or access to the server code.[15]
Tools that work with OpenAPI
[edit]The OpenAPI Initiative maintains a list of implementations for version 3.0 of the specification. SmartBear still brands its OpenAPI tools with the Swagger moniker. The Swagger UI framework allows both developers and non-developers to interact with the API in a sandbox UI that gives insight into how the API responds to parameters and options. Swagger can handle both JSON and XML.[15]
Swagger Codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing the OpenAPI definition. In July, 2018, William Cheng, the top contributor to Swagger Codegen, and over 40 other contributors to Swagger Codegen forked the code into a project named OpenAPI Generator under the OpenAPI Tools organization.[17][18]
Annual conference
[edit]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
[edit]References
[edit]- ^ "New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services". Archived from the original on 31 October 2023.
- ^ "OpenAPI Initiative Charter". OpenAPI Initiative. Retrieved 12 November 2019.
- ^ "Swagger creator joins SmartBear". Retrieved 6 August 2019.
- ^ "SmartBear Assumes Sponsorship of Swagger API Open Source Project". SmartBear. Retrieved 25 March 2015.
- ^ "FAQ". OpenAPI Initiative. Retrieved 12 November 2019.
- ^ "New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services". linuxfoundation.org. Archived from the original on 27 April 2016. Retrieved 22 April 2016.
- ^ OpenAPI Initiative. "OpenAPI Specification". GitHub. Retrieved 12 November 2019.
- ^ "The OAI Announces the OpenAPI Specification 3.0.0". OpenAPIs. 26 July 2017. Retrieved 19 April 2018.
- ^ Avram, Abel (6 May 2017). "The HTTP API space is Consolidating around OAS". InfoQ. Retrieved 14 May 2017.
- ^ "OpenAPI Specification 3.1.0 Available Now". Linux.com. 26 April 2021. Retrieved 26 April 2021.
- ^ Charboneau, Tyler (7 April 2021). "What's New in OpenAPI 3.1.0?". Nordic APIs. Retrieved 7 April 2021.
- ^ "OpenAPI Specification 3.1.0 Released". OpenAPI Initiative. 18 February 2021. Retrieved 18 February 2021.
- ^ Sturgeon, Phil (16 February 2021). "Migrating from OpenAPI 3.0 to 3.1.0". OpenAPI Initiative. Retrieved 16 February 2021.
- ^ "OpenAPI Specification Version 3.1.0". GitHub. Retrieved 7 November 2023.
- ^ a b c "swagger-api/swagger-spec". GitHub. Archived from the original on 4 June 2016. Retrieved 1 December 2015.
- ^ Preibisch, Sascha (2018). API Development: A Practical Guide for Business Implementation Success. [Berkeley, CA]: Apress. ISBN 978-1-4842-4140-0. OCLC 1076234393.
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.
- ^ Hoppe, Johannes (2018). "Swagger Codegen is now OpenAPI Generator". Angular.Schule. Retrieved 6 August 2019.
- ^ "Swagger Codegen Fork: Q&A". OpenAPI Generator. Retrieved 6 August 2019.
Bibliography
[edit]- Haupt, F.; Karastoyanova, D.; Leymann, F.; Schroth, B. (2014). A Model-Driven Approach for REST Compliant Services. ICWS 2014. 2014 IEEE International Conference on Web Services. pp. 129–136. doi:10.1109/ICWS.2014.30. ISBN 978-1-4799-5054-6.
- Pautasso, Cesare (2021). Beautiful APIs. LeanPub. p. 100.
External links
[edit]- OpenAPI Initiative (OAI) website
- API Specifications Conference (ASC) website
- Swagger website
- OpenAPI Specification on GitHub
- Directory of OpenAPI definitions
- OpenAPI Editor: A rich UI Eclipse OpenAPI (OAS) editor and studio to design, develop and test OAS3/OpenAPI
- OpenAPI for EDI the Electronic data interchange
- Example of a Petstore client/server specification.