Metody a nástroje pro specifikaci a dokumentaci REST API

Vladimír Vojtíšek

Bakalářská práce

Method and tools for REST API specification and documentation

Anotace:

Bakalářská práce se zabývá metodami a nástroji pro specifikaci a dokumentaci REST API, což je klíčová oblast moderního vývoje softwaru, zejména ve webových a mobilních aplikacích. V teoretické části je cílem analyzovat různé existující technologie a nástroje, které se používají pro návrh a dokumentaci REST API. Zvláštní pozornost je věnována standardům, jako jsou OpenAPI (Swagger), RAML a API Blueprint, a jejich srovnání z hlediska přehlednosti, flexibility a použitelnosti v praxi. Dále se zaměřuje na nástroje pro tvorbu dokumentace, jako jsou Swagger UI, Postman nebo Redoc, a na to, jak tyto nástroje přispívají k efektivnímu vývoji API. V praktické části práce je navržen a implementován modelový REST API systém, který demonstruje využití různých specifikačních metod a nástrojů pro dokumentaci. Slouží jako případová studie k představení, jak různé technologie ovlivňují proces vývoje a správy API. Výsledkem bude srovnání vybraných metod a nástrojů na základě jejich praktické použitelnosti a výkonu v reálném světě.

Abstract:

The bachelor’s thesis addresses methods and tools for the specification and documentation of REST APIs, which constitute a key area of modern software development, especially in web and mobile applications. The objective of the theoretical part is to analyze various existing technologies and tools used for the design and documentation of REST APIs. Attention is paid to standards such as OpenAPI (Swagger), RAML, and API Blueprint, and to their comparison in terms of clarity, flexibility, and practical usability. Furthermore, the thesis focuses on documentation tools such as Swagger UI, Postman, and Redoc, and examines how these tools contribute to efficient API development. In the practical part of the thesis, a model REST API system is designed and implemented to demonstrate the use of different specification methods and documentation tools. It serves as a case study showing how various technologies influence the API development and management process. The result is a comparison of selected methods and tools based on their practical applicability and performance in real-world.

Klíčová slova

REST API, správa API, OpenAPI (Swagger), RAML, API Blueprint

Keywords

REST API, API management, OpenAPI (Swagger), RAML, API Blueprint

Jazyk práce: čeština

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

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

• Obhajoba proběhla 5. 2. 2026
• Vedoucí: Ing. Marek Beránek, Ph.D.
• Oponent: Ivo Milota

Unicorn Vysoká škola s.r.o.

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