Αυτοµατοποίηση λειτουργίας και documentation API

Αμπατζή, Ναυσικά; Ampatzi, Nafsika

dc.contributor.author	Αμπατζή, Ναυσικά	el
dc.contributor.author	Ampatzi, Nafsika	en
dc.date.accessioned	2022-10-12T10:24:27Z
dc.date.available	2022-10-12T10:24:27Z
dc.identifier.uri	https://dspace.lib.ntua.gr/xmlui/handle/123456789/55901
dc.identifier.uri	http://dx.doi.org/10.26240/heal.ntua.23599
dc.rights	Default License
dc.subject	API Documentation	en
dc.subject	Postman	en
dc.subject	Visual Paradigm	en
dc.subject	OpenAPI	en
dc.subject	JSON	en
dc.title	Αυτοµατοποίηση λειτουργίας και documentation API	el
heal.type	bachelorThesis
heal.classification	Software Engineering	en
heal.language	el
heal.access	free
heal.recordProvider	ntua	el
heal.publicationDate	2022-07-05
heal.abstract	Κανείς µπορεί να έχει στα χέρια του το καλύτερο REST API, αλλά ϑα είναι αδύνατο να το χρησιµοιήσει σωστά εάν πρώτα δεν το έχει κατανοήσει. Σε αυτό το σηµείο ορίζεται η έννοια του API Documentation, το οποίο αποτελεί ένα έγγραφο που περιγράφει το πως ϑα χρησιµοποιηθεί ένα API. Συχνά το Documentation των REST APIs γίνεται µε το χέρι, κάτι το οποίο είναι χρονοβόρο και µε σηµαντικές πιθανότητες λάθους. Υπάρχουν εργαλεία τα οποία διευκολύνουν τη δηµιουργία, επεξεργασία και παρουσίαση του API Documentation. Σε αυτή την εργασία ϑα παρουσιαστεί µία µέθοδος η οποία συνδυάζει τα εργαλεία Postman και Visual Paradigm, µε σκοπό την αυτοµατοποίηση της διαδικασίας παραγωγής και παρουσίασης του API Documentation. Μέσω του εργαλείου Postman µπορούν να δηµιουργηθούν συλλογές από requests µε όλες τις απαραίτητες πληροφορίες, όπως body, responses, headers κ.α. Μέσω του εργαλείου Visual Paradigm µπορεί να αναπαρασταθεί ένα OpenAPI Documentation ή να παραχθεί το Documentation του από µία API αναπαράσταση. Μέσω της εργασίας αυτής δηµιουργήθηκε ένα απλό σύστηµα, το οποίο δέχεται ως είσοδο την περιγραφή µίας συλλογής από requests του Postman και παράγει το OpenAPI Documentation. Το αρχείο που παράγεται µπορεί να οπτικοποιηθεί µέσω του Visual Paradigm ως REST API. Επιπλέον το σύστηµά µας, επιτελεί και την αντίστροφη λειτουργία. Μέσω ενός REST API σχεδιασµένο στο Visual Paradigm, παράγει το OpenAPI Documentation του. Χρησιµοποιώντας το Documentation αυτό στη συνέχεια µπορεί να δηµιουργηθεί ένα REST API στο Postman.	el
heal.advisorName	Βεσκούκης, Βασίλειος	el
heal.committeeMemberName	Τσανάκας, Παναγίωτης	el
heal.committeeMemberName	Γκούμας, Γεώργιος	el
heal.academicPublisher	Εθνικό Μετσόβιο Πολυτεχνείο. Σχολή Ηλεκτρολόγων Μηχανικών και Μηχανικών Υπολογιστών. Τομέας Τεχνολογίας Πληροφορικής και Υπολογιστών	el
heal.academicPublisherID	ntua
heal.numberOfPages	86 σ.	el
heal.fullTextAvailability	false