Insomnia — τι είναι, πελάτης REST και GraphQL στην ανάπτυξη

Τι είναι το Insomnia και τα βασικά χαρακτηριστικά

Insomnia — εφαρμογή πολλαπλών πλατφορμών (Electron) για αποστολή HTTP αιτημάτων και αποσφαλμάτωση API. Αναπτύσσεται από την εταιρεία Kong από το 2016 ως εναλλακτική λύση στο Postman με έμφαση στην ταχύτητα εργασίας και την εμπιστευτικότητα: τα δεδομένα αποθηκεύονται τοπικά, ο συγχρονισμός στο cloud είναι προαιρετικός και απαιτεί εγγραφή.

Περιβάλλον εργασίας και πλοήγηση

Το κύριο παράθυρο χωρίζεται σε τρεις στήλες: αριστερά — το δέντρο αιτημάτων (Workspace), στο κέντρο — ο επεξεργαστής αιτημάτων με τις καρτέλες Params, Headers, Body, δεξιά — ο πίνακας απόκρισης με τις λειτουργίες Pretty, Raw και Preview. Το σκούρο θέμα είναι ενεργοποιημένο από προεπιλογή, και υποστηρίζονται προσαρμοσμένα θέματα μέσω μεταβλητών CSS.

Δημιουργία κώδικα

Το Insomnia υποστηρίζει εξαγωγή αιτήματος σε κώδικα σε πάνω από 20 γλώσσες και πλαίσια: cURL, HTTPie, Python Requests, JavaScript Fetch/Axios, Kotlin OkHttp, Swift URLSession, Java Unirest, Ruby Net::HTTP και άλλα. Ο γεννήτορας λαμβάνει υπόψη τις κεφαλίδες, το σώμα του αιτήματος και τον τύπο ταυτοποίησης, γεγονός που επιταχύνει την ενσωμάτωση του API στον κώδικα της εφαρμογής.

Insomnia εναντίον Postman: σύγκριση πελατών API

Insomnia και Postman επιλύουν την ίδια εργασία, αλλά με διαφορετικές προτεραιότητες. Το Insomnia είναι πιο ελαφρύ (~80 MB έναντι ~300 MB), εκκινεί πιο γρήγορα και λειτουργεί πλήρως εκτός σύνδεσης χωρίς να επιβάλλει εγγραφή. Το Postman προσφέρει πιο ώριμο οικοσύστημα με παρακολούθηση, mock διακομιστές και ομαδικά workspace.

Επιλογή εργαλείου ανάλογα με την εργασία

Για ατομική ανάπτυξη και γρήγορη δοκιμή endpoint, το Insomnia είναι πιο βολικό χάρη στην ελαφρότητά του και στην απουσία εγγραφής. Για ομαδική εργασία με κοινή συλλογή, ενσωμάτωση CI/CD και παρακολούθηση API παραγωγής, το Postman παραμένει το πρότυπο του κλάδου.

Οργάνωση χώρου εργασίας και περιβαλλόντων

Workspace στο Insomnia περιέχει το δέντρο αιτημάτων, χωρισμένο σε φακέλους. Κάθε αίτημα μπορεί να είναι τύπου HTTP, GraphQL, WebSocket ή gRPC. Υποστηρίζεται η μεταφορά, ο διπλασιασμός και η ομαδοποίηση αιτημάτων κατά έγχρωμες ετικέτες. Το αρχείο διαμόρφωσης του workspace αποθηκεύεται σε μορφή JSON.

Μεταβλητές περιβάλλοντος με κληρονομικότητα

Το Insomnia υποστηρίζει ένθετα περιβάλλοντα (Sub Environments) που κληρονομούν τις μεταβλητές του γονέα. Αυτό επιτρέπει τον ορισμό βασικού URL στο καθολικό περιβάλλον και την επαναδιαγραφή μόνο των διαφορετικών παραμέτρων για διαφορετικά περιβάλλοντα. Οι μεταβλητές αντικαθίστανται μέσω της σύνταξης {`{`}_variable${`}`}.

// Παράδειγμα δομής περιβάλλοντος Insomnia
{
    "base_url": "https://api.example.com",
    "timeout": 5000,
    "headers": {
        "Content-Type": "application/json",
        "Accept": "application/json"
    }
}

Εργασία με GraphQL στο Insomnia

Insomnia παρέχει έναν από τους καλύτερους επεξεργαστές GraphQL μεταξύ των πελατών API. Η καρτέλα GraphQL Query επιτρέπει τη σύνταξη αιτημάτων με αυτόματη συμπλήρωση πεδίων βάσει του φορτωμένου σχήματος. Δεξιά εμφανίζεται σε πραγματικό χρόνο η τεκμηρίωση των τύπων, των πεδίων και των ορισμάτων.

Φόρτωση σχήματος και Introspection

Το σχήμα φορτώνεται μέσω αιτήματος GraphQL Introspection προς το endpoint. Το Insomnia αποθηκεύει το σχήμα τοπικά στην κρυφή μνήμη και το ενημερώνει αυτόματα στις αλλαγές. Μετά τη φόρτωση διατίθενται αυτόματη συμπλήρωση (Ctrl+Space), επικύρωση αιτήματος και προεπισκόπηση πιθανών σφαλμάτων πριν από την αποστολή.

# Αίτημα GraphQL με μεταβλητές στο Insomnia
query GetUser($id: ID!) {
    user(id: $id) {
        name
        email
        posts {
            title
            createdAt
        }
    }
}

Πρόσθετα και επέκταση δυνατοτήτων

Insomnia Plugin Hub περιέχει περισσότερα από 100 πρόσθετα που επεκτείνουν τη λειτουργικότητα του πελάτη. Τα πρόσθετα εγκαθίστανται μέσω του μενού Preferences → Plugins ή χειροκίνητα μέσω npm. Οι δημοφιλείς κατηγορίες περιλαμβάνουν δημιουργία δοκιμαστικών δεδομένων, εξαγωγή σε διάφορες μορφές και προσαρμοσμένους ελεγκτές απόκρισης. Κάθε πρόσθετο περνά από υποχρεωτική εποπτεία πριν από τη δημοσίευση στον κοινό κόμβο προγραμματιστών.

Δημοφιλή πρόσθετα

• insomnia-plugin-faker — δημιουργία ψευδών δεδομένων (όνομα, email, τηλέφωνο) για δοκιμαστικά αιτήματα.
• insomnia-plugin-aws4 — υπογραφή αιτημάτων σύμφωνα με το AWS Signature Version 4 για εργασία με Amazon API Gateway και S3.
• insomnia-plugin-utils — βοηθητικά εργαλεία για εργασία με ημερομηνίες, κατακερματισμό και κωδικοποίηση Base64 απευθείας στα αιτήματα.

Τα πρόσθετα γράφονται σε JavaScript και αλληλεπιδρούν με το Insomnia μέσω του API προτύπων (response.*, request.*, environment.*). Η ανάπτυξη πρόσθετου απαιτεί βασικές γνώσεις Node.js και δημοσίευση μέσω πακέτου npm με ετικέτα insomnia-plugin.

CLI και αυτοματοποίηση δοκιμών

Inso CLI — εργαλείο κονσόλας ενσωματωμένο στο Insomnia για την εκτέλεση αιτημάτων και δοκιμών από το τερματικό. Το Inso εκτελεί μεμονωμένα αιτήματα ή ολόκληρες συλλογές, εξάγει αποτελέσματα σε JSON και μπορεί να ενσωματωθεί σε αγωγούς CI/CD. Η εντολή inso run collection εκτελεί διαδοχικά όλα τα αιτήματα της συλλογής.

Παράδειγμα ενσωμάτωσης σε GitHub Actions

Το Inso CLI λειτουργεί σε κοντέινερ Docker και σε λειτουργία headless, γεγονός που επιτρέπει τη χρήση του σε GitHub Actions και GitLab CI. Η διαμόρφωση εκτέλεσης περιγράφεται σε αρχείο YAML με αναφορά της διαδρομής προς την εξαγόμενη συλλογή και το περιβάλλον. Υποστηρίζονται ισχυρισμοί στον κωδικό κατάστασης και στο σώμα απόκρισης μέσω σεναρίων JavaScript.

# Workflow GitHub Actions με Inso CLI
- name: Run API tests
  run: npx insomnia-inso run collection
    --collection "Auth API"
    --env "Staging"
    --reporter junit
    --output reports/api-results.xml

Ενσωμάτωση Insomnia με το Git και ομαδική εργασία

Insomnia υποστηρίζει συγχρονισμό συλλογών μέσω Git. Τα αρχεία συλλογών αποθηκεύονται σε μορφή JSON και μπορούν να προστεθούν στο αποθετήριο του έργου. Το Insomnia παρέχει ενσωματωμένο Git πελάτη για προβολή αλλαγών, δημιουργία commits και επίλυση συγκρούσεων συγχώνευσης απευθείας από το περιβάλλον εργασίας.

Ρύθμιση συγχρονισμού Git

Για να συνδέσετε το Git, δημιουργήστε τοπικό φάκελο με αποθετήριο και ορίστε τον ως ριζικό κατάλογο στις ρυθμίσεις του Insomnia. Η εφαρμογή παρακολουθεί αυτόματα τις αλλαγές στα αρχεία συλλογής και τις εμφανίζει στον πίνακα Version Control. Υποστηρίζονται τυπικές λειτουργίες: commit, push, pull και προβολή diff μεταξύ εκδόσεων.

Ομαδική εργασία μέσω Insomnia Cloud

Για έργα χωρίς Git, το Insomnia προσφέρει συγχρονισμό στο cloud μέσω Insomnia Cloud. Το δωρεάν πρόγραμμα περιλαμβάνει έως 3 μέλη ομάδας και αυτόματη δημιουργία αντιγράφων ασφαλείας των συλλογών. Τα πληρωμένα προγράμματα προσθέτουν διαχείριση πρόσβασης, έλεγχο αλλαγών και υποστήριξη προτεραιότητας.

Design Mode και δημιουργία προδιαγραφών

Design Mode στο Insomnia επιτρέπει τη δημιουργία προδιαγραφών API σε μορφή OpenAPI 3.0. Η λειτουργία λειτουργεί ως οπτικός επεξεργαστής: ορίστε endpoints και σχήματα δεδομένων χωρίς να γράφετε YAML χειροκίνητα. Η προδιαγραφή μπορεί να εξαχθεί σε JSON ή YAML.

Δημιουργία συλλογής από OpenAPI

Το Insomnia εισάγει προδιαγραφές OpenAPI και δημιουργεί συλλογή αιτημάτων για κάθε endpoint. Οι διαδρομές και τα σχήματα μετατρέπονται σε έτοιμα HTTP αιτήματα. Η λειτουργία είναι χρήσιμη κατά την ενσωμάτωση με μικροϋπηρεσίες, όπου η προδιαγραφή αποθηκεύεται σε ξεχωριστό αποθετήριο της ομάδας.

Επισήμανση αιτημάτων

Σε κάθε αίτημα μπορεί να αποδοθεί έγχρωμη ετικέτα: red, blue, green, orange, purple. Το φιλτράρισμα κατά ετικέτες λειτουργεί μέσω της γραμμής αναζήτησης ανεξάρτητα από τη δομή των φακέλων, γεγονός που απλοποιεί την πλοήγηση σε έργα με εκατοντάδες endpoints και πολλά δομοστοιχεία.

Design Mode και δημιουργία προδιαγραφών

Design Mode στο Insomnia επιτρέπει τη δημιουργία προδιαγραφών API σε μορφή OpenAPI 3.0 απευθείας μέσα στην εφαρμογή. Η λειτουργία λειτουργεί ως οπτικός επεξεργαστής: ορίστε endpoints, σχήματα δεδομένων και παραμέτρους χωρίς να γράφετε YAML χειροκίνητα. Η προδιαγραφή μπορεί να εξαχθεί σε JSON ή YAML για δημοσίευση στο αποθετήριο.

Δημιουργία συλλογής από OpenAPI

Το Insomnia εισάγει υπάρχουσες προδιαγραφές OpenAPI και δημιουργεί αυτόματα συλλογή αιτημάτων για κάθε endpoint. Οι διαδρομές και τα σχήματα μετατρέπονται σε έτοιμα HTTP αιτήματα με σωστούς τύπους δεδομένων. Αυτή η λειτουργία είναι χρήσιμη κατά την ενσωμάτωση με μικροϋπηρεσίες, όπου η προδιαγραφή αποθηκεύεται και συντηρείται από ξεχωριστή ομάδα προγραμματιστών backend.

Επισήμανση και φιλτράρισμα αιτημάτων

Για την οργάνωση μεγάλου αριθμού αιτημάτων, το Insomnia υποστηρίζει επισήμανση — σε κάθε αίτημα μπορεί να αποδοθεί έγχρωμη ετικέτα: red, blue, green, orange, purple. Το φιλτράρισμα κατά ετικέτες λειτουργεί μέσω της γραμμής αναζήτησης ανεξάρτητα από τη δομή των φακέλων, γεγονός που απλοποιεί την πλοήγηση σε έργα με εκατοντάδες endpoints και πολλά λειτουργικά δομοστοιχεία API.