Αυτόματη παραγωγή τεκμηρίωσης εξαρτήσεων μεταξύ κλήσεων endpoints ενός REST API

Παπαδέας, Παναγιώτης; Papadeas, Panagiotis

dc.contributor.author	Παπαδέας, Παναγιώτης	el
dc.contributor.author	Papadeas, Panagiotis	en
dc.date.accessioned	2023-10-10T10:09:18Z
dc.date.available	2023-10-10T10:09:18Z
dc.identifier.uri	https://dspace.lib.ntua.gr/xmlui/handle/123456789/58145
dc.identifier.uri	http://dx.doi.org/10.26240/heal.ntua.25841
dc.rights	Default License
dc.subject	API	en
dc.subject	REST	en
dc.subject	HTTP	en
dc.subject	XML	en
dc.subject	JSON	en
dc.subject	RPC	en
dc.subject	Postman	en
dc.subject	Visual Paradigm	en
dc.subject	OpenAPI	en
dc.subject	API Documentation	en
dc.subject	Python3	en
dc.subject	SOAP	en
dc.title	Αυτόματη παραγωγή τεκμηρίωσης εξαρτήσεων μεταξύ κλήσεων endpoints ενός REST API	el
heal.type	bachelorThesis
heal.classification	Τεχνολογία λογισμικού	el
heal.language	el
heal.access	free
heal.recordProvider	ntua	el
heal.publicationDate	2023-07-04
heal.abstract	Στην εποχή της πληροφορίας, χρειαζόμαστε τεχνολογίες που να χειρίζονται τα δεδομένα γρήγορα και αποδοτικά και να είναι συμβατές με τις περισσότερες εφαρμογές. Τα APIs είναι ιδανικά για αυτό το σκοπό. Τα REST APIs ειδικότερα, αποκτούν όλο και μεγαλύτερη δημοφιλία λόγω της ευχρηστίας και της κλιμακωσιμότητάς τους. Για να χρησιμοποιήσουμε όμως ένα REST API σωστά πρέπει πρώτα να το κατανοήσουμε. Το API Documentation αποτελεί ένα έγγραφο που περιγράφει πώς θα χρησιμοποιηθεί ένα API. Ωστόσο, πολλές φορές η πληροφορία που περιέχει δεν επαρκεί. Συγκεκριμένα, τα διαφορετικά endpoints ενός REST API εμφανίζουν συχνά σχέσεις εξάρτησης μεταξύ τους οι οποίες επιβάλλουν μια σειρά προτεραιότητας στον τρόπο κλήσης τους. Θέμα της εργασίας μας αποτελεί η αναγνώριση αυτών των εξαρτήσεων, η αυτόματη παραγωγή του Documentation και η δημιουργία ενός γράφου που θα τις αναδεικνύει και θα βοηθάει τον χρήστη να κατανοήσει τον τρόπο με τον οποίο συνδέονται τα endpoints σε ένα REST API. Σε αυτή την εργασία θα παρουσιαστεί μία μέθοδος η οποία συνδυάζει τα εργαλεία Postman και Visual Paradigm με σκοπό την αυτοματοποίηση της διαδικασίας παραγωγής και παρουσίασης ενός API Documentation το οποίο περιλαμβάνει την κατάλληλη πληροφορία για την ανάδειξη των σχέσεων εξάρτησης. Με το Postman μπορούμε να δημιουργήσουμε συλλογές από requests σε ένα REST API με όλες τις απαραίτητες πληροφορίες όπως request bodies, response bodies, headers κ.α. Με το εργαλείο Visual Paradigm μπορεί να παραχθεί ένα OpenAPI Documentation ή να προκύψει μια API αναπαράσταση από αυτό. Μέσω λοιπόν της εργασίας αυτής δημιουργούμε ένα σύστημα το οποίο παράγει αυτόματα OpenAPI Documentations για REST APIs, τα οποία περιέχουν πληροφορία για τις εξαρτήσεις μεταξύ των endpoints. Ακόμη, επεξεργάζεται υπάρχοντα OpenAPI Documentations προκειμένου να εισάγει σε αυτά την απαραίτητη πληροφορία. Τέλος παρουσιάζουμε το αποτέλεσμα σε έναν αναλυτικό γράφο όπου είναι φανερές οι εξαρτήσεις μεταξύ των διαφορετικών endpoints ενός REST API.	el
heal.advisorName	Βεσκούκης, Βασίλειος	el
heal.committeeMemberName	Βεσκούκης, Βασίλειος	el
heal.committeeMemberName	Τσανάκας, Παναγιώτης	el
heal.committeeMemberName	Παγουρτζής, Αριστείδης	el
heal.academicPublisher	Εθνικό Μετσόβιο Πολυτεχνείο. Σχολή Ηλεκτρολόγων Μηχανικών και Μηχανικών Υπολογιστών. Τομέας Τεχνολογίας Πληροφορικής και Υπολογιστών	el
heal.academicPublisherID	ntua
heal.numberOfPages	96 σ.	el
heal.fullTextAvailability	false