OpenAPI Specification: Difference between revisions

Revision as of 01:48, 21 March 2023

Revision as of 07:22, 12 June 2023

Line 78:

==Usage==

Applications implemented based on OpenAPI interface files can automatically generate documentation of methods, parameters and models[[data model]]<nowiki/>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}}</ref>

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

=== Relationships to software engineering practices ===

Line 99:

* [[Representational state transfer|Representational State Transfer]]

* [[gRPC]]

* [[Data modeling|Data modelling]]

==References==