פתרון בעיות בשימוש ב-API

בדף הזה מוסבר למפתחי אפליקציות איך לפתור בעיות בשימוש שלהם בממשקי Google API ובממשקי Google Cloud API.

רקע

ממשקי Google API הם ממשקי API ברשת שמסופקים על ידי שירותי Google. אפליקציות יכולות לגשת ל-Google APIs באמצעות JSON HTTP ו-gRPC מסביבות שונות. אנחנו ממליצים למפתחים להשתמש בספריות לקוח שסופקו על ידי Google באפליקציות שלהם. הספריות האלה מטמיעות לוגיקה נפוצה של קוד חוזר, כמו אימות וחלוקה לדפים של רשימות, מה שמפחית באופן משמעותי את התקורה של הפיתוח ואת הטעויות הנפוצות.

מידע נוסף זמין במאמר הסבר על ספריות לקוח.

תחילת העבודה

אם אתם חדשים ב-Google APIs, כדאי לעיין בדף תחילת העבודה כדי להשלים את שלבי ההכנה של האפליקציה. קודם כדאי להשתמש בפקודה curl -v כדי לשלוח בקשות בדיקה ל-Google APIs שבהם רוצים להשתמש. כך תוכלו להתנסות ב-Google APIs בלי לכתוב קוד. לרוב אפשר לפתור הרבה בעיות לפני שמתחילים לפתח אפליקציה אמיתית.

מידע נוסף זמין במאמר תחילת העבודה.

פתרון בעיות באמצעות מדדים

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

מידע נוסף מופיע במאמר ניטור השימוש ב-API.

פתרון בעיות באמצעות יומנים

מטעמי אבטחה ופרטיות, Google APIs בדרך כלל לא מספקים יומני API למפתחי אפליקציות. אנחנו ממליצים מאוד למפתחי אפליקציות לרשום ביומן את שגיאות ה-API בצד הלקוח. אפשר לרשום את השגיאות ביומן באחסון מקומי או ב-API לרישום ביומן מרחוק, כמו Cloud Logging API.

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

יומני ביקורת של Cloud

בפעילויות שקשורות לאבטחה, מוצרי Google Cloud עשויים ליצור יומני ביקורת שמכילים מידע מפורט על הפעילויות. הם מקור מצוין למידע שיעזור לכם לפתור בעיות בשימוש בממשקי Google Cloud API. לדוגמה, התכונה של הרצת בדיקה יבשה ב-VPC Service Controls יוצרת יומני ביקורת שאדמינים יכולים להשתמש בהם כדי להעריך את השינויים במדיניות שעומדים להתבצע.

מידע נוסף זמין במאמר בנושא יומני ביקורת של Cloud.

השגיאות בתהליך תיקון

אם נתקלתם בבעיות בשימוש ב-Google API ומצאתם את המדדים והיומנים המתאימים, תוכלו לפעול לפי ההוראות בדף שגיאות במדריך לעיצוב API כדי לפתור את השגיאות.

באופן כללי, כל שגיאה ב-API כוללת 3 חלקי מידע: קוד שגיאה, הודעת שגיאה ופרטי שגיאה:

  • קוד השגיאה מאפשר לאפליקציות לטפל בשגיאה ברמה גבוהה יותר, למשל לנסות שוב אחרי שגיאות 503 או לבצע אימות מחדש של משתמשים אחרי שגיאות 401.

  • הודעת השגיאה מאפשרת למפתחי האפליקציות להבין את השגיאה ולתקן את הלוגיקה של האפליקציה.

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

מידע נוסף זמין בדף שגיאות.