Metody a nástroje pro specifikaci/dokumentaci REST API (kdo a v jaké fázi projektu má API definovat, jak to udělat, tak, aby se na něm shodl SWA a BA, jak ho zdokumentovat tak, aby šla definice využít rovnou i ve vývoji, jak zajistit, aby se realita a specifikace časem nebyly v souladu...)

Jiří Teplický

Bakalářská práce

Methods and Tools for Specification/Documentation of REST API (who and at which project phase should define API, how to achieve consensus among SWA and BA, how to document it to enable immediate utilization in development, how to ensure that reality and specification remain aligned over time...)

Anotace:

REST API, Specification, Documentation, OpenAPI, Swagger, API testing, Automations, Versioning

Abstract:

The aim of this bachelor thesis is to analyze methods and tools for the specification and documentation of REST APIs. The thesis focuses on the API design process, enabling effective collaboration between software architects (SWA) and business analysts (BA). It describes how to ensure consistency between the API specification and its implementation and how to leverage modern tools such as OpenAPI and Swagger for documentation automation. The research methods employed include the analysis of existing tools and the practical application of REST architecture principles. The thesis proposes methods for maintaining up-to-date API documentation despite changing business requirements. The results include process and tool recommendations that enhance consistency between documentation, implementation, and testing, thereby improving development efficiency. The thesis utilizes a broad range of resources, including expert literature and practical implementation examples. The proposed methodologies were validated through real-world scenarios, emphasizing their practical applicability.

Klíčová slova

REST API, Specifikace, Dokumentace, OpenAPI, Swagger, Testování API, Automatizace, Versioning

Keywords

REST API, Specification, Documentation, OpenAPI, Swagger, API testing, Automations, Versioning

Jazyk práce: čeština

Datum vytvoření / odevzdání či podání práce: 9. 1. 2025

Obhajoba závěrečné práce

• Obhajoba proběhla 3. 2. 2025
• Vedoucí: Ing. Marek Beránek, Ph.D.
• Oponent: Michal Kökörčený

Unicorn Vysoká škola s.r.o.

Bakalářský studijní program:
Softwarový vývoj