Generated Type-Safe Client SDKs Released

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

מה חדש

בפוסט ההגירה שלנו ל-TypeScript, הזכרנו שה-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 כדי לייצר ספריות לקוח עבור כל שפה.

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

מה נמצא בכל SDK

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

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

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

תיעוד

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

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

לסיכום

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

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

לחיים!