ספריות לקוח של Developer Knowledge API

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

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

התקנת ספריית הלקוח

בוחרים את שפת התכנות כדי להתקין את ספריית הלקוח הרשמית של Developer Knowledge API:

Go

מוסיפים את המודול לפרויקט Go:

go get cloud.google.com/go/developerknowledge/apiv1

מידע נוסף זמין במאמר הגדרת סביבת פיתוח בשפת Go.

Java

אם משתמשים ב-Maven, מוסיפים את התלות הבאה לקובץ pom.xml:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-developer-knowledge</artifactId>
  <version>0.6.0</version>
</dependency>

אם משתמשים ב-Gradle, מוסיפים את התלות הבאה לקובץ build.gradle:

implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'

מידע נוסף זמין במאמר הגדרת סביבת פיתוח בשפת Java.

‫Node.js ו-TypeScript

מתקינים את החבילה באמצעות npm:

npm install @google/developer-knowledge

מידע נוסף זמין במאמר בנושא הגדרת סביבת פיתוח של Node.js.

PHP

מתקינים את החבילה באמצעות Composer:

composer require google/developer-knowledge

מידע נוסף זמין במאמר בנושא שימוש ב-PHP ב-Google Cloud.

Python

מתקינים את החבילה באמצעות pip:

pip install --upgrade google-developer-knowledge

מידע נוסף זמין במאמר הגדרת סביבת פיתוח בשפת Python.

Ruby

מתקינים את ה-gem:

gem install google-developers-developer_knowledge

מידע נוסף זמין במאמר הגדרת סביבת פיתוח בשפת Ruby.

מגדירים אימות

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

כדי לאמת קריאות ל-Developer Knowledge API, ספריות הלקוח תומכות ב-Application Default Credentials ‏ (ADC). בספריות מתבצע חיפוש של פרטי כניסה בקבוצה של מיקומים מוגדרים, והמערכת משתמשת בפרטי הכניסה האלה כדי לאמת בקשות ל-API. בעזרת ADC, פרטי הכניסה לאפליקציה יכולים להיות זמינים בסביבות שונות, כמו בפיתוח מקומי או בייצור, בלי שיהיה צריך לשנות את קוד האפליקציה.

בסביבות ייצור, הדרך שבה מגדירים את ADC תלויה בשירות ובהקשר:

  • סביבות Google Cloud: כשהאפליקציה פועלת ב-Cloud Run, ב-Google Kubernetes Engine, ב-Compute Engine או בפונקציות של Cloud Run,‏ ADC משתמש באופן אוטומטי בחשבון השירות שמצורף למשאב המחשוב.
  • סביבות חיצוניות או מקומיות: משתמשים באיחוד שירותי אימות הזהות של עומסי עבודה או מגדירים את משתנה הסביבה GOOGLE_APPLICATION_CREDENTIALS לנתיב של קובץ תצורה עם פרטי כניסה.

מידע נוסף על אפשרויות של פרטי כניסה לייצור זמין במאמר בנושא הגדרה של Application Default Credentials.

בסביבת פיתוח מקומית, אפשר להגדיר את ADC עם פרטי הכניסה שמשויכים לחשבון Google:

  1. מתקינים ומפעילים את ה-CLI של gcloud.

  2. יצירת פרטי כניסה לאימות מקומי בחשבון Google:

    gcloud auth application-default login

    מסך הכניסה יופיע. אחרי שנכנסים, פרטי הכניסה נשמרים בקובץ פרטי הכניסה המקומי שמשמש את ADC.

מקורות מידע נוספים

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

Go

ברשימה הבאה מופיעים קישורים למקורות מידע נוספים שקשורים לספריית הלקוח של Go:

Java

ברשימה הבאה מופיעים קישורים למקורות מידע נוספים שקשורים לספריית הלקוח של Java:

‫Node.js ו-TypeScript

ברשימה הבאה מופיעים קישורים למקורות מידע נוספים שקשורים לספריית הלקוח של Node.js ו-TypeScript:

PHP

ברשימה הבאה מופיעים קישורים למקורות מידע נוספים שקשורים לספריית הלקוח של PHP:

Python

ברשימה הבאה מופיעים קישורים למקורות מידע נוספים שקשורים לספריית הלקוח של Python:

Ruby

ברשימה הבאה מופיעים קישורים למקורות מידע נוספים שקשורים לספריית הלקוח של Ruby:

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