Efektivní modelování OpenAPI: Integrace verzování a znovupoužitelných API komponent

Abstract

Diplomová práce se věnuje návrhu řešení pro správu OpenAPI specifikací, které slouží k jednoznačnému popisu HTTP API. Návrh vychází z analýzy stávajících nástrojů pro správu OpenAPI a nabízí alternativní přístup s důrazem na rozšiřitelnost, podporu verzování a modelování OpenAPI specifikací z opakovatelně použitelných komponent. Výsledkem práce je backendová aplikace s rozhraním popsaným pomocí OpenAPI specifikace, která tvoří základ pro implementaci grafického uživatelského rozhraní pro správu specifikací. Aplikace umožňuje definovat HTTP API prostřednictvím zjednodušených konstruktů a následně generovat OpenAPI specifikaci, čímž snižuje nároky na hlubší znalost standardu a zároveň rozšiřuje možnosti návrhu o prvky, které OpenAPI přímo nepodporuje.

The thesis focuses on the management of OpenAPI specifications, which serve to describe HTTP APIs unambiguously. It builds upon the strengths and weaknesses of existing tools and proposes an alternative approach that simplifies the creation and maintenance of specifications. The goal is to design an extensible system that supports the versioning and modelling of OpenAPI specifications using reusable components. The result of the work is an application with an interface described by an OpenAPI specification, which serves as a foundation for implementing a graphical user interface. The application interface allows users to define HTTP API through simplified constructs and subsequently generate an OpenAPI specification, thereby reducing the need for in-depth knowledge of the standard and extending the design possibilities to include features not directly supported by OpenAPI.