OpenAPI Specification: Difference between revisions

Revision as of 17:57, 23 August 2024

Revision as of 23:55, 17 September 2024

Line 77:

==Usage==

The OAS describes the format for OpenAPI Descriptions (OADs),<ref>{{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> 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 [[data model]]s. 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 |url-status=deviated |archive-url=https://archive.today/20160604140815/https://github.com/OAI/OpenAPI-Specification/wiki |archive-date= 4 Jun 2016 }}</ref>

Applications implementedcan baseduse onOADs OpenAPI interface files canto automatically generate documentation of methods, parameters and [[data model]]s. This helps keep the [[Software documentation|documentation]], client libraries and source code in sync.<ref name=git>{{Citecite web|title=OpenAPI Documentation: Introduction |website=Learn OpenAPI swagger-api/swagger-spec|url=https://githublearn.comopenapis.org/swagger-api/swagger-spec/wikiintroduction.html |website publisher=The GitHub|access-dateOpenAPI =Initiative 2015-12-01 |url-statusdate=deviated2023 |archiveaccess-urldate=https://archive.today/20160604140815/https://github.com/OAI/OpenAPI2024-Specification/wiki |archive09-date= 4 Jun 2016 17}}</ref>

When an OpenAPI document is used to generate source code stubs for servers, the process is called [[Scaffold (programming)|scaffolding]].