Content deleted Content added
Restored revision 1122470189 by Levinda987 (talk): Rv blogs as sources |
Lnbuistern (talk | contribs) Add relationships to software engineering practices. This time, with better citations. |
||
Line 50:
==Usage==
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>
When an OpenAPI document is used to generate source code, 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 an 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 |url=https://www.worldcat.org/oclc/1076234393 |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==
| |||