הושקו SDKs קליינטיים בטוחים בסוג שנוצרו

! מאמר זה מכיל מונחים טכניים

מה חדש

במאמר שלנו על מיגרציה ל-TypeScript, הזכרנו שהשחרור של SDKs קליינטיים שנוצרו מתקרב. הם כאן.

FastComments עכשיו משחררת SDKs רשמיים, בטוחים בסוג עבור עשר שפות:

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

כל SDK נוצר מהspecification של OpenAPI אותו המערכת שלנו מייצרת. סוגים, חותמות שיטה, ודגמים של בקשות/תגובות נשארים מסונכרנים עם ה-API בפועל אוטומטית. הקומפילטור שלך תופס טעויות בשם השדה ופרמטרים חסרים לפני שהקוד שלך עושה בקשת רשת כלשהי.

כיצד זה עובד

המיגרציה ל-TypeScript הייתה דרישה מוקדמת לכך. עכשיו שהקוד של השרת שלנו הוא בעל סוגים מלאים, אנחנו משתמשים ב-הסניף שלנו של TSOA כדי לייצר specification של OpenAPI 3.0 ישירות מהמנהלי מסלול שלנו. ה-spec הזה מוזן ל-OpenAPI Generator כדי להפיק ספריות קליינט עבור כל שפה.

כאשר ה-API משתנה, הכלים שלנו מזהים את ההבדל ב-spec, מחדשים את ה-SDKs המושפעים, מריצים בדיקות עבור כל שפה, ופותחים בקשות משיכה אוטומטית. בנינו כלי ניהול קטן ב-Nim שמניע את מחזור העדכון-בדיקה-שחרור בכל עשרת הרפוזיטוריות.

מה יש בכל SDK

כל SDK מספק שתי מחלקות API:

• DefaultApi: נקודות קצה מאומתות שדורשות את מפתח ה-API שלך. השתמש בזה בצד השרת לניהול, ניהול משתמשים, אנליטיקות, ולפעולות המוניות.
• PublicApi: נקודות קצה שאינן מאומתות ובטוח לקרוא מהדפדפנים ואפליקציות ניידות. אלה כוללות שליפת תגובות, פרסום, הצבעה, ופעולות נוספות המיועדות ללקוח.

כל ה-SDKs כוללים גם כלי SSO לשילוב עם מערכת האימות הקיימת שלך. ה-SDK של TypeScript נוסף מספק גם מנויים על אירועים בזמן אמת עבור תגובות חי.

תיעוד

תיעוד מלא של ה-API זמין ב-docs.fastcomments.com. כל רפוזיטוריית SDK כוללת גם תיעוד שנוצר שמכסה כל שיטה ודגם זמין.

לשילוב SSO, ראה את מדריך ה-SSO שלנו. כל עשרת ה-SDKs כוללים עזרי SSO המשתמשים בספריות קריפטוגרפיה מקומיות.

לסיכום

הקיום של שרת בעל סוגים מלאים הפך את זה לפשוט לייצר specification אמינה של OpenAPI, ומשם, ייצור קליינט עבור עשר (וש someday יותר!) שפות היה בעיקר עניין של בניית האוטומציה ושיפור ההגדרות שלנו כך שהן יהיו ניתנות לצריכה, מבלי להוסיף יותר מדי הפשטה שתאט את FastComments!

כמו בכל השקות גדולות, אנחנו שמחים שנוכל לקחת את הזמן כדי לייעל, לבדוק, ולשחרר כראוי את ה-SDKs האלה. הניחו לנו לדעת למטה אם יש לכם משוב או אם יש שפה שאתם רוצים שנוסיף.

בהצלחה!