Αυτοματοποίηση Λειτουργίας και Documentation API

Abstract

Κανείς μπορεί να έχει στα χέρια του το καλύτερο REST API, αλλά θα είναι αδύνατο να το χρησιμοιήσει σωστά εάν πρώτα δεν το έχει κατανοήσει. Σε αυτό το σημείο ορίζεται η έννοια του API Documentation, το οποίο αποτελεί ένα έγγραφο που περιγράφει το πως θα χρησιμοποιηθεί ένα API. Συχνά το Documentation των REST APIs γίνεται με το χέρι, κάτι το οποίο είναι χρονοβόρο και με σημαντικές πιθανότητες λάθους. Υπάρχουν εργαλεία τα οποία διευκολύνουν τη δημιουργία, επεξεργασία και παρουσίαση του API Documentation. Σε αυτή την εργασία θα παρουσιαστεί μία μέθοδος η οποία συνδυάζει τα εργαλεία Post- man και Visual Paradigm, με σκοπό την αυτοματοποίηση της διαδικασίας παραγωγής και παρουσίασης του API Documentation. Μέσω του εργαλείου Postman μπορούν να δημιουρ- γηθούν συλλογές από requests με όλες τις απαραίτητες πληροφορίες, όπως body, responses, headers κ.α. Μέσω του εργαλείου Visual Paradigm μπορεί να αναπαρασταθεί ένα OpenAPI Documentation ή να παραχθεί το Documentation του από μία API αναπαράσταση. Μέσω της εργασίας αυτής δημιουργήθηκε ένα απλό σύστημα, το οποίο δέχεται ως είσοδο την περιγραφή μίας συλλογής από requests του Postman και παράγει το OpenAPI Docu- mentation. Το αρχείο που παράγεται μπορεί να οπτικοποιηθεί μέσω του Visual Paradigm ως REST API. Επιπλέον το σύστημά μας, επιτελεί και την αντίστροφη λειτουργία. Μέσω ε- νός REST API σχεδιασμένο στο Visual Paradigm, παράγει το OpenAPI Documentation του. Χρησιμοποιώντας το Documentation αυτό στη συνέχεια μπορεί να δημιουργηθεί ένα REST API στο Postman.