| Form of studies |
Bachelor |
| Title of the study programm |
Information Technology |
| Title in original language |
RESTful API dokumentēšanas rīku salīdzinošā analīze |
| Title in English |
Comparative Analysis of Tools for Documenting RESTful API |
| Department |
Faculty Of Computer Science Information Tehnology And Energy |
| Scientific advisor |
Oksana Ņikiforova |
| Reviewer |
Oskars Rodiņš |
| Abstract |
Darbs ir veltīts rīka izstrādei, kas atvieglo un paātrina RESTful API (angl. Application Programming Interface) dokumentēšanas procesu. Šis rīks ļauj unificēt un automatizēt specifikāciju rakstīšanu datu saņemšanai servera pusē, kas ievērojami paātruna izstrādātāju darbu. Darbā sniegts pārskats par esošajiem specifikāciju datu kartēšanas rīkiem, kas ir atvērtā koda un bezmaksas, un aprakstīti kritēriji, pēc kuriem šie rīki ir izvērtēti, lai analizētu to efektivitāti un uzticamību.
Analīze liecina, ka izstrādātāji saskarnes punktu specifikācijas attēlošanai visbiežāk izvēlas vienu un to pašu rīku. Viņi neņem vērā, ka pastāv ērtākas alternatīvas, kas varētu ievērojami paātrināt gan RESTful API dokumentēšanas, gan uzturēšanas procesu. Tas noved pie mazāk efektīvas specifikācijas izstrādes, kas negatīvi ietekmē API izstrādes un uzturēšanas ātrumu un kvalitāti.
Balstoties uz RESTful API dokumentēšanas rīku salīdzināšanas rezultātiem, darba autors ir izstrādājis vadlīnijas saskarnes punktu dokumentācijas izstrādei un izvirzījis prasības integrētam risinājumam, kas darbā ir realizēts kā izstrādes projektā integrējamā npm (agl. node package manager) pakotne balstīta uz Rapidoc dokumentāciju. Bakalaura darba ietvaros šīs risinājums ir realizēts prototipa veidā, kas ģenerē saskarnes punktu specifikāciju pēc autora definētam vadlīnijām. RESTful API dokumentēšanas automātiskā ģenerēšana ļauj ietaupīt laiku un nodrošina specifikāciju rakstīšanas pareizību. Darbā ir sniegts praktisks piemērs šī rīka prorotipa izmantošanai. Rīks tika integrēts projektā, un rezultāti parādīja tā veiksmīgu darbību un efektivitāti. |
| Keywords |
RESTful API, Redoc, Rapidoc, Swagger, OpenAPI, RAML, API Blueprint, Lietotāja saskarne. |
| Keywords in English |
RESTful API, Redoc, Rapidoc, Swagger, OpenAPI, RAML, API Blueprint, UI. |
| Language |
lv |
| Year |
2024 |
| Date and time of uploading |
28.05.2024 15:38:21 |
