מדריך למתחילים: תחילת העבודה עם Developer Knowledge API

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

לפני שמתחילים

הפעלת ה-API

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

יצירה ואבטחה של מפתח API

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

חיפוש של חלקי מסמכים

אחרי שמקבלים את מפתח ה-API של Developer Knowledge, אפשר להתחיל להשתמש ב-API. בדוגמה הבאה מוסבר איך לחפש נתחי מסמכים שקשורים ל-BigQuery:

  1. שומרים את מפתח Developer Knowledge API במשתנה סביבה:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    מחליפים את הערך YOUR_API_KEY במפתח ה-API שיצרתם.

  2. משתמשים ב-curl כדי להתקשר לנקודת הקצה searchDocumentChunks:

    curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

הפקודה הזו מחזירה רשימה של חלקי מסמכים שתואמים לשאילתה, כולל קטעי מידע מהתוכן ו-parent לכל מסמך.

שחזור מסמך

התשובה מ-searchDocumentChunks מכילה רשימה של חלקי מסמכים. לכל מקטע של מסמך יש שדה parent, שבו אפשר להשתמש כדי לאחזר את התוכן המלא של המסמך באמצעות GetDocument.

מעתיקים את parent של אחד מחלקי המסמך שהוחזרו על ידי הקריאה searchDocumentChunks (לדוגמה, documents/developers.google.com/...), שומרים אותו במשתנה סביבה ומשתמשים ב-curl כדי לקרוא לנקודת הקצה GetDocument:

export DOC_NAME="DOCUMENT_NAME"

curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

הפונקציה מחזירה את תוכן ה-Markdown המלא של המסמך שצוין.

המאמרים הבאים