| | SLO | ENG | Cookies and privacy

Bigger font | Smaller font

Show document Help

Title:Pomen in dobre prakse dokumentiranja programskih vmesnikov storitev rest : diplomsko delo
Authors:ID Sikošek, Aljoša (Author)
ID Heričko, Marjan (Mentor) More about this mentor... New window
Files:.pdf UN_Sikosek_Aljosa_2024.pdf (1,02 MB)
MD5: 141012E78D795F6460268211CB6327CF
 
Language:Slovenian
Work type:Bachelor thesis/paper
Typology:2.11 - Undergraduate Thesis
Organization:FERI - Faculty of Electrical Engineering and Computer Science
Abstract:Diplomsko delo obravnava pomen in dobre prakse dokumentiranja programskih vmesnikov storitev REST. Dokumentacija storitev REST je ključna za zagotavljanje jasnosti, učinkovitosti in vzdrževanja programske opreme, saj razvijalcem omogoča enostavno razumevanje in uporabo vmesnikov. Delo se osredotoča na osnovne pojme in metode, povezane z dokumentiranjem REST API-jev, ter na pregled orodij in tehnik, ki olajšujejo ta proces. Cilj diplomskega dela je analizirati in predstaviti najboljše prakse dokumentiranja vmesnikov REST ter pomagati razvijalcem pri izboru tehnologije in efikasni uporabi le teh.
Keywords:razvoj programske opreme, programski vmesniki, dokumentacija Swagger, OpenAPI, storitve REST
Place of publishing:Maribor
Place of performance:Maribor
Publisher:[A. Sikošek]
Year of publishing:2024
Number of pages:1 spletni vir (1 datoteka PDF (X, 41 f.))
PID:20.500.12556/DKUM-90350 New window
UDC:004.413.01(043.2)
COBISS.SI-ID:221051907 New window
Publication date in DKUM:07.10.2024
Views:117
Downloads:34
Metadata:XML DC-XML DC-RDF
Categories:KTFMB - FERI
:
Copy citation
  
Average score:(0 votes)
Your score:Voting is allowed only for logged in users.
Share:Bookmark and Share



Hover the mouse pointer over a document title to show the abstract or click on the title to get all document metadata.

Licences

License:CC BY-NC-ND 4.0, Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International
Link:http://creativecommons.org/licenses/by-nc-nd/4.0/
Description:The most restrictive Creative Commons license. This only allows people to download and share the work for no commercial gain and for no other purposes.
Licensing start date:30.08.2024

Secondary language

Language:English
Title:Best practices and importance of rest api documentation
Abstract:The thesis deals with the importance and good practices of documenting the programming interfaces of REST services. Documentation of REST services is critical to ensuring clarity, efficiency and maintainability of software by making the interfaces easy for developers to understand and use. The work focuses on the basic concepts and methods related to documenting REST APIs and an overview of tools and techniques that facilitate this process. The aim of the thesis is to analyze and present the best practices of documenting REST interfaces and to help developers in the selection of technology and efficient use of only these.
Keywords:software development, APIs, Swagger documentation, OpenAPI, REST services


Comments

Leave comment

You must log in to leave a comment.

Comments (0)
0 - 0 / 0
 
There are no comments!

Back
Logos of partners University of Maribor University of Ljubljana University of Primorska University of Nova Gorica