Generated Type-Safe Client SDKs Released

! Αυτό το άρθρο περιέχει τεχνική ορολογία

Τι νέο

Στην TypeScript migration post, αναφέραμε ότι θα κυκλοφορούσαν παραγόμενα client SDKs. Είναι εδώ.

Το FastComments τώρα παρέχει επίσημα, τύπου-ασφαλή SDKs για δέκα γλώσσες:

• TypeScript / JavaScript (npm)
• Python (GitHub)
• Rust (crates.io)
• Go (Go modules)
• Java (Maven)
• PHP (Composer)
• Ruby (RubyGems)
• Swift (Swift Package Manager)
• C++ (CMake)
• Nim (Nimble)

Κάθε SDK παράγεται από την ίδια προδιαγραφή OpenAPI που παράγει ο διακομιστής μας. Οι τύποι, οι υπογραφές μεθόδων και τα μοντέλα αίτησης/απάντησης παραμένουν συγχρονισμένα με το πραγματικό API αυτόματα. Ο μεταγλωττιστής σας εντοπίζει τυπογραφικά λάθη στα ονόματα πεδίων και ελλιπείς παραμέτρους πριν ο κώδικάς σας κάνει οποιοδήποτε αίτημα δικτύου.

Πώς λειτουργεί

Η μετάβαση σε TypeScript ήταν προαπαιτούμενο για αυτό. Τώρα που ο κώδικας του διακομιστή μας είναι πλήρως τυποποιημένος, χρησιμοποιούμε our fork of TSOA για να δημιουργήσουμε μια προδιαγραφή OpenAPI 3.0 απευθείας από τους ελεγκτές διαδρομών μας. Η προδιαγραφή αυτή τροφοδοτείται στο OpenAPI Generator για να παραχθούν βιβλιοθήκες client για κάθε γλώσσα.

Όταν το API αλλάζει, τα εργαλεία μας εντοπίζουν τη διαφορά στην προδιαγραφή, επαναδημιουργούν τα επηρεαζόμενα SDKs, εκτελούν δοκιμές για κάθε γλώσσα και ανοίγουν αυτόματα pull requests. Δημιουργήσαμε ένα μικρό εργαλείο διαχείρισης σε Nim που συντονίζει τον κύκλο ενημέρωσης-δοκιμής-κυκλοφορίας σε όλα τα δέκα αποθετήρια.

Τι περιέχει κάθε SDK

Κάθε SDK παρέχει δύο κλάσεις API:

• DefaultApi: αυθεντικοποιημένα endpoints που απαιτούν το κλειδί API σας. Χρησιμοποιήστε τα στο server για συντονισμό, διαχείριση χρηστών, αναλύσεις και μαζικές λειτουργίες.
• PublicApi: μη αυθεντικοποιημένα endpoints ασφαλή για κλήση από browsers και mobile apps. Αυτά καλύπτουν την ανάκτηση σχολίων, την αποστολή, την ψήφο και άλλες λειτουργίες προς το client.

Όλα τα SDKs περιλαμβάνουν επίσης βοηθητικά εργαλεία SSO για ενσωμάτωση με το υπάρχον σύστημα αυθεντικοποίησης. Το TypeScript SDK επιπλέον παρέχει συνδρομές σε πραγματικό χρόνο για γεγονότα ζωντανής σχολιασμού.

Τεκμηρίωση

Η πλήρης τεκμηρίωση API είναι διαθέσιμη στο docs.fastcomments.com. Κάθε αποθετήριο SDK περιλαμβάνει επίσης παραγόμενα docs που καλύπτουν κάθε διαθέσιμη μέθοδο και μοντέλο.

Για ενσωμάτωση SSO, δείτε τον SSO guide. Όλα τα δέκα SDKs περιλαμβάνουν βοηθητικά SSO χρησιμοποιώντας τις εγγενείς βιβλιοθήκες κρυπτογραφίας τους.

Συμπερασματικά

Το ότι ο διακομιστής είναι πλήρως τυποποιημένος το έκανε απλό να δημιουργηθεί μια αξιόπιστη προδιαγραφή OpenAPI, και από εκεί, η δημιουργία client για δέκα (και κάποια μέρα περισσότερες!) γλώσσες ήταν κυρίως θέμα κατασκευής της αυτοματοποίησης και βελτίωσης των ορισμών τύπων μας ώστε να είναι καταναλώσιμα, χωρίς να προσθέτουμε υπερβολική αφαίρεση που θα επιβραδύνει το FastComments!

Όπως και με όλες τις μεγάλες κυκλοφορίες, είμαστε ευχαριστημένοι που μπορέσαμε να αφιερώσουμε χρόνο στη βελτιστοποίηση, τις δοκιμές και τη σωστή κυκλοφορία αυτών των SDKs. Ενημερώστε μας παρακάτω αν έχετε οποιαδήποτε σχόλια ή αν υπάρχει κάποια γλώσσα που θα θέλατε να προσθέσουμε.

Στην υγειά σας!