Developer Knowledge API

תצוגה מקדימה

השימוש במוצר הזה כפוף לתנאי השימוש במוצרים בגרסת טרום-GA, שמפורטים בחלק "תנאי שירות הכלליים" בתנאים הספציפיים של השירות. השימוש במוצרים בגרסת טרום-GA הוא "כפי שהם" (As is), ויכול להיות שהתמיכה בהם תהיה מוגבלת. אתם יכולים לקרוא מידע נוסף בקטע תיאור שלבי ההשקה.

‫Developer Knowledge API מאפשר גישה פרוגרמטית לתיעוד הפומבי של Google למפתחים, וכך לשלב את בסיס הידע הזה באפליקציות ובסביבות העבודה שלכם.

סקירה כללית

ה-Developer Knowledge API נועד להיות המקור הקנוני לגישה בפורמט קריא למכונה למאמרי העזרה למפתחים של Google. הוא מציע שתי פונקציות עיקריות:

• ‫SearchDocumentChunks כדי למצוא מזהי URI של דפים רלוונטיים וקטעי תוכן על סמך שאילתה.
• ‫GetDocument או ‫BatchGetDocuments כדי לאחזר את התוכן המלא של תוצאות החיפוש.

כדי להתחיל במהירות, כדאי לעיין במדריך למתחילים.

מאגר התוכן שאפשר לחפש בו מפורט בהפניה למאגר.

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

הפעלת ה-API

כדי להשתמש ב-Developer Knowledge API, צריך קודם להפעיל אותו בפרויקט ב-Google Cloud.

טיפ: אם אין לכם פרויקט בענן של Google, צרו אותו באמצעות ההוראות ל-Google Cloud או ל-Firebase.

1. פותחים את הדף של Developer Knowledge API בספריית Google APIs.
2. מוודאים שבחרתם את הפרויקט הנכון שבו אתם רוצים להשתמש ב-API.
3. לוחצים על הפעלה. לא נדרשים תפקידים ספציפיים ב-IAM כדי להפעיל את ה-API או להשתמש בו.

אימות

כדי להשתמש ב-Developer Knowledge API, צריך מפתח API של Developer Knowledge. כדי ליצור אחד:

1. במסוף Google Cloud, בפרויקט שבו הפעלתם את ה-API, עוברים אל הדף Credentials.
2. לוחצים על Create credentials ובתפריט בוחרים באפשרות API key. בתיבת הדו-שיח API key created (מפתח API נוצר) מוצגת המחרוזת של המפתח החדש שיצרתם.
3. לוחצים על עריכת מפתח API.
4. בשדה Name (שם), מזינים שם למפתח.
5. בקטע API restrictions, בוחרים באפשרות Restrict key.
6. ברשימה Select APIs, מפעילים את Developer Knowledge API ולוחצים על OK.
   • הערה: אם הפעלתם עכשיו את Developer Knowledge API, יכול להיות שיחלוף זמן מה עד שהוא יופיע ברשימה Select APIs.
7. לוחצים על שמירה.

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

מסמכים כלולים

בהפניית הקורפוס מוסבר אילו מסמכים נסרקים על ידי ה-API.

מגבלות ידועות

• איכות ה-Markdown: ה-Markdown נוצר מקוד ה-HTML של המקור. יכול להיות שיהיו אי-התאמות או בעיות עיצוב.
• היקף התוכן: נכללים רק דפים ציבוריים בהפניה לקורפוס. התוכן לא כולל תוכן ממקורות אחרים כמו GitHub, אתרי OSS, בלוגים או YouTube.