Interaktivní webová dokumentace pro Protocol Buffers

Abstract

Tato diplomová práce představuje analýzu existujících nástrojů pro dokumentaci, návrh, implementaci a testování statického generátoru webových stránek určeného pro gRPC API, který umožňuje interaktivní volání API prostřednictvím gRPC-Web. Řešení využívá společný formát JSON pro definice a zahrnuje dva generátory: jeden pro proto soubory a druhý pro reflexi gRPC. Tento systém umožňuje uživatelům prozkoumávat gRPC service, message typy a enum, včetně jejich dokumentačních komentářů. Dále umožňuje interakci s gRPC API, což uživatelům umožňuje provádět volání a zobrazovat výsledky v reálném čase. S cílem zlepšit vývoj bude tato práce zpřístupněna veřejně pro gRPC komunitu, čímž poskytne cenný nástroj pro vývojáře pracující s gRPC API.

This master thesis presents the analysis of existing documentation tools, design, implementation, and testing of a static website generator tailored for gRPC APIs, enabling interactive API calls via gRPC-Web. The solution leverages a common JSON format for definitions and incorporates two generators: one for proto files and another for gRPC reflection. This system allows users to explore gRPC services, message types, and enums, complete with their documentation comments. It also facilitates live interaction with the gRPC API, allowing users to execute calls and view real-time results. Aiming to enhance the developer experience, this work will be publicly available to the gRPC community, providing a valuable tool for developers working with gRPC APIs.