אנחנו שמחים להודיע ש-Looker API 4.0 זמין לכולם ב-Looker 22.4. גרסה 4.0 של ה-API (API 4.0 GA) זמינה לכולם, והיא כוללת שינויים רבים שעלולים לשבור את התאימות לאחור, וגם שינויים שמוסיפים פונקציונליות. בנוסף, כמה נקודות קצה (endpoint) עברו מגרסת בטא לגרסה יציבה. פרטים נוספים על API 4.0 זמינים במאמרי העזרה של ה-API. עדכנו את ערכות ה-SDK שנתמכות על ידי Looker ואת ערכות ה-SDK שנתמכות על ידי הקהילה כדי לתמוך בנקודות הקצה של Looker API 4.0 GA. מידע נוסף זמין במאמרים מדיניות התמיכה בממשקי API ובערכות SDK וניהול גרסאות של API. בהמשך המאמר הזה נפרט את השינויים שעלולים לשבור את התאימות, את הפתרונות ואת התכונות החדשות שתוכלו ליהנות מהם כשמעבירים ל-API 4.0 GA.
למי מיועד המאמר הזה?
המאמר הזה מיועד למי שמשתמש ב-Looker API דרך ערכות SDK שנתמכות על ידי Looker, ערכות SDK שנתמכות על ידי הקהילה או ה-API עצמו. קוראים את הסעיף הבא שמתאים לגרסת Looker API שבה אתם משתמשים.
משתמשי API 4.0 טרום-GA
אם אתם משתמשים ב-API 4.0, כדאי לקרוא את הקטע הזה. המאמר כולל מידע על שינויים שעלולים לשבור את התאימות ועל פתרונות זמינים למזעור הסיכון, כשעוברים ל-API 4.0 GA.
הגרסה הזמינה לכולם של API 4.0 כוללת שינוי של כל שדות מזהי הישויות מסוג integer לסוג string. לדוגמה, הפקודה GET /groups/{group_id} endpoint תחזיר את הערך id כסוג string במקום כסוג int64.
בטבלה הבאה מפורטים ההשפעה והפתרונות שרלוונטיים לשימוש בנקודת הקצה של API 4.0:
| שימוש | ההשלכות1 | מניעה |
| אפליקציות לנייד של Looker | התקנות מיושנות של אפליקציות Looker לנייד מפסיקות לפעול | המשתמשים צריכים לעדכן לגרסה האחרונה של אפליקציות Looker לנייד |
| SDKs2 שנתמכים ב-Looker | ||
| TypeScript SDK (גרסה 4.0 של API) | אין השפעה | לא נדרשת פעולה |
| Python SDK (4.0 API) | אין השפעה | לא נדרשת פעולה |
| Ruby SDK (4.0 API) | אין השפעה | לא נדרשת פעולה |
| SDKs2 עם תמיכה מהקהילה | ||
| Swift SDK | חריגות בזמן ריצה | מעדכנים את ה-SDK לגרסה 22.0 ואילך, ואז פותרים את שגיאות הטיפוס שנוצרות, אם יש כאלה. |
| Kotlin SDK | אין השפעה | לא נדרשת פעולה |
| LookR SDK | אין השפעה | לא נדרשת פעולה |
| C# SDK | אין השפעה | לא נדרשת פעולה |
| Go SDK | חריגות בזמן ריצה | מעדכנים את ה-SDK לגרסה 22.0 ואילך, ואז פותרים את שגיאות הטיפוס שנוצרות, אם יש כאלה. |
| אחר | ||
| שימוש ב-API בגרסה 4.0 ללא SDK (או עם ספריות שסופקו חיצונית) | שגיאות אפשריות בזמן ריצה, בהתאם לרגישות לסוג של השפה | בודקים את הקוד כדי לראות אם יש תלות בסוג של שדות מזהים, ומוסיפים תמיכה בשדות מזהים מסוג מחרוזת. מומלץ לעיין גם בהנחיות הנוספות האלה. |
1: בהנחה של דפוסי שימוש נפוצים שעשויים לכלול שימוש בשדות מזהים של Looker, אבל לא דפוסי שימוש חריגים כמו הפעלת פעולות מספריות על מזהים.
2: Looker API & SDK support. ספריות עם תמיכה מהקהילה לא נתמכות רשמית על ידי Looker.
משתמשי API 3.1
אם אתם משתמשים ב-API 3.1, כדאי לקרוא את הקטע הזה. המאמר כולל הסבר על התכונות הנוספות והשינויים שזמינים לכם ב-API 4.0. חשוב לזכור שכל ערכות ה-SDK שלנו שנתמכות על ידי Looker ועל ידי הקהילה תומכות בעיקר ב-API 4.0. מידע נוסף זמין במאמר בנושא מדיניות התמיכה ב-SDK וב-API.
תכונות נוספות ב-API 4.0 GA
לנוחיותכם, ריכזנו כאן את השינויים החשובים והשימושיים ביותר ב-API 4.0:
- יצירה וניהול של לוחות, פריטים בלוח וקטעים בלוח. מידע נוסף על לוחות זמין בדף התיעוד של לוחות.
- אפשר להריץ שאילתות על פרטי קישור נוספים כמו מסדי נתונים, סכימות, עמודות וטבלאות. הגדרת שדות חיבור נוספים ועדכון שלהם.
- יצירה וניהול של אפליקציות ומשתמשים ב-OAuth. מידע נוסף על OAuth זמין בדף התיעוד של OAuth.
- חיפוש קבוצות עם היררכיה ותפקידים.
- חיפוש תפקידים עם מספר המשתמשים.
- קבלת והגדרת הגדרות של מופע Looker. מידע נוסף על הגדרות מופיע בדף התיעוד בנושא הגדרות.
- יצירה וניהול של התראות. מידע נוסף על התראות מופיע בדף התיעוד בנושא התראות.
- יצירה, ניהול ובדיקה של מנהרות SSH ושרתי SSH. מידע נוסף על SSH זמין בדף התיעוד בנושא SSH.
- העברה והעתקה של לוחות בקרה.
- איך מקבלים כתובות URL יחסיות למרכזי בקרה חדשים
- העברה והעתקה של מראה.
- הטמעה חתומה וסוד הטמעה לא חתום, כתובת URL, יצירה וניהול של משתמשים.
- קבלת טוקן רענון כדי לרענן את טוקן הגישה להתחברות.
- הגבלת התוצאות והוספת היסט כדי לאחזר את כל מודלי LookML ואת כל המשתמשים.
- הגבלת התוצאות ושינוי המיקום שלהן מחיפוש משתמשים.
- איך מקבלים את מפרט ה-API של מופע Looker ב-JSON בפורמט Swagger 2.x
שינויים בהוצאה משימוש של API 4.0 GA
גרסת API 4.0 GA מחליפה כמה נקודות קצה (endpoints) של API 3.1 שהוצאו משימוש בתכונות משופרות. נקודות הקצה הבאות מושפעות:
- הוסרו נקודות קצה של דף הבית שהוצאו משימוש. במקום דפי הבית, צריך להשתמש בנקודות קצה של לוחות. איך מציגים תוכן באמצעות לוחות
- הוסרו נקודות קצה של מרחבים שיצאו משימוש. במקום במרחב, משתמשים בנקודות קצה של תיקיות. איך מארגנים ומנהלים את הגישה לתוכן
משתמשי API 3.0
API 3.0 הוצא משימוש, ומומלץ לעבור ל-API 4.0.
- רק API 4.0 תומך בכל ערכות ה-SDK שנתמכות על ידי Looker ועל ידי הקהילה, כדי להקל על הפיתוח. כדאי לעיין במאגר ה-SDK שלנו.
- ב-API 4.0 נוספו תכונות חדשות ושיפורים רבים, כמו שמופיע בקטע תכונות נוספות של API 4.0 GA בדף הזה.
סיכום
אתם יכולים לצפות לתכונות חדשות ולשינויים מצטברים שיצטרפו ל-API 4.0, ותמיד תוכלו למצוא את השינויים האחרונים במאמרי העזרה של ה-API. מידע נוסף זמין במאמרים מדיניות התמיכה בממשקי API ובערכות SDK וניהול גרסאות של API. אנחנו יודעים ששינויים שגורמים לבעיות הם לא אידיאליים. אלא אם תתעורר בעיה חמורה, לא נבצע שינויים שעלולים לשבור את התאימות בגרסה 4.0 של ה-API שזמינה לכולם. אנחנו מקווים ש-Looker API 4.0, שזמין עכשיו לכלל המשתמשים, יעזור לכם לפתח מוצרים בפלטפורמת Looker בצורה יעילה וקלה יותר.