API dokumentācijas automatizācija

Abstract

Šī bakalaura darba literatūras analīzes daļā tiek pētīta API dokumentācijas nozīme un dažādas dokumentācijas pieejas (manuāla, automatizēta un hibrīda). Darbā tiek analizēti un izvērtēti esošie API dokumentēšanas papildrīki un to galvenās priekšrocības un trūkumi un to atbilstība izvērtēta klienta prasībām. Praktiskajā daļā tiek aprakstita klienta mājaslapas arhitektūra un tās ietvaros izstrādāts dokumentācijas automatizācijas rīks, iekļaujot funkciju API metadatu automātisku apkopošanu un lietotāju saskarni ērtai dokumentācijas skatīšanai un filtrēšanai. Lietotne tika testēta un pielāgota sistēmas tehnoloģiskajām un lietojamības prasībām.

The literature analysis section of this Bachelor’s thesis researches the importance of API documentation and various methods of documentation (manual, automated and hybrid). The thesis analyzes and evaluates existig API documentation tools, their most significant advantages and limitations, as well as their suitability to the client’s requirements. In the practical section, the architecture of the client’s web platform is described, and a documentation automation tool is developed within it, including a function for automatic aggregation of API metadata and a user interface for a convenient viewing of the documentation and its filtrering. The application was tested and made to meet the system’s technological and usability requirements.