Zefektívnenie dokumentácie API pomocou automatizácie na báze GenAI

Zvyšovanie produktivity a efektívnosti dokumentácie API

Popredný poskytovateľ riešení v oblasti prenájmu potreboval optimalizovať dokumentáciu API na podporu rôznorodých technológií a zároveň fungovať v rámci rozpočtových obmedzení. Zákazník na automatizáciu generovania špecifikácií Swagger (OpenAPI) pre približne 60 služieb využil CodeBuddy, jedno z SDLC riešení spoločnosti GlobalLogic na báze umelej inteligencie. Riešenie odstránilo opakujúce sa manuálne úlohy, čím prinieslo približne 15 % zvýšenie produktivity a skrátilo čas potrebný na ukončenie dokumentácie API z mesiacov na hodiny. Zákazník získal štandardizovanú a kvalitnú dokumentáciu s minimálnym zásahom vývojárskeho tímu.

Výzva

Klient potreboval efektívnejší spôsob generovania a starostlivosti o dokumentáciu API vo viacerých programovacích jazykoch vrátane Ruby on Rails, Kotlin a Python. Manuálna tvorba špecifikácií Swagger bola časovo náročná a hrozila pri nej nekonzistentnosť, čo spomaľovalo časový harmonogram vývoja riešení. Spoločnosť sa tieto problémy snažila prekonať automatizáciou dokumentácie, zvyšovaním presnosti a uvoľnením vývojárov na prácu na úlohách s vyššou pridanou hodnotou.

Vytvorená hodnota

Spoločnosť GlobalLogic nasadila CodeBuddy, jedno z našich SDLC riešení na zefektívnenie dokumentácie API, ktoré:

• automatizuje generovanie špecifikácií Swagger (OpenAPI ) pre približne 60 služieb, a tým eliminuje manuálnu prácu.
• redukuje čas dokumentácie z mesiacov na hodiny, čím výrazne urýchľuje časový harmonogram projektu.
• zabezpečuje jasnú štandardizovanú a presnú dokumentáciu API s minimálnym zásahom vývojárov.

Odstránenie problematických miest a zlepšenie kvality dokumentácie klientovi umožnilo dosiahnuť vyššiu efektivitu vývoja riešení a rýchlejšie prijatie API v rámci jeho tímov.

Riešenie

Spoločnosť GlobalLogic úzko spolupracovala s vývojárskym tímom na strane klienta na integrácii dokumentácie na báze AI do klientovho pracovného postupu. Táto efektívna spolupráca umožnila rýchle iterácie a riešenie problémov už na základnej úrovni. Agilné slučky spätnej väzby zabezpečovali kontinuálne zlepšovanie a proces bol bezproblémový a vysoko efektívny. Vývojári sa tak mohli sústrediť na kľúčové inovácie, zatiaľ čo dokumentácia sa spracovávala automaticky. Výsledkom bolo zvýšenie produktivity aj kvality softvéru.

Zautomatizovali sme dokumentáciu API, zvýšili sme efektívnosť a produktivitu vývojárov, a tým sme pomocou automatizácie na báze GenAI zredukovali mesiace manuálnej práce na niekoľko hodín.