التشغيل السريع: بدء استخدام Developer Knowledge API

يوضّح لك هذا الدليل كيفية بدء استخدام Developer Knowledge API. ستتعرّف على كيفية تفعيل واجهة برمجة التطبيقات Developer Knowledge API والحصول على مفتاح لها وإجراء أول طلبات البيانات من واجهة برمجة التطبيقات للبحث عن مستندات المطوّرين واستردادها.

قبل البدء

تفعيل واجهة برمجة التطبيقات

  1. افتح صفحة Developer Knowledge API في مكتبة Google APIs.
  2. تأكَّد من اختيار المشروع الصحيح الذي تنوي استخدام واجهة برمجة التطبيقات فيه.
  3. انقر على تفعيل. لا تتطلّب واجهة برمجة التطبيقات أي أدوار محدّدة في "إدارة الهوية وإمكانية الوصول" لتفعيلها أو استخدامها.

إنشاء مفتاح واجهة برمجة التطبيقات وتأمينه

  1. في Google Cloud Console للمشروع الذي فعّلت فيه واجهة برمجة التطبيقات، انتقِل إلى صفحة "بيانات الاعتماد".
  2. انقر على إنشاء بيانات اعتماد، ثمّ اختَر مفتاح واجهة برمجة التطبيقات من القائمة.
  3. في حقل الاسم، أدخِل اسمًا للمفتاح.
  4. انقر على القائمة المنسدلة اختيار قيود واجهة برمجة التطبيقات، ثم اكتب Developer Knowledge API. انقر على النتيجة، ثم انقر على حسنًا.
    • ملاحظة: إذا فعّلت واجهة برمجة التطبيقات Developer Knowledge API للتو، قد يستغرق ظهورها في القائمة بعض الوقت. انتظر بضع دقائق وأعِد المحاولة.
  5. انقر على إنشاء.

البحث عن أجزاء من المستندات

بعد الحصول على مفتاح واجهة برمجة التطبيقات Developer Knowledge API، يمكنك البدء في استخدام واجهة برمجة التطبيقات. يوضّح المثال التالي كيفية البحث عن أجزاء من المستندات ذات الصلة بـ "BigQuery":

  1. احفظ مفتاح Developer Knowledge API في متغيّر بيئة:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    استبدِل YOUR_API_KEY بمفتاح واجهة برمجة التطبيقات الذي أنشأته.

  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 الكامل للمستند المحدّد.

الخطوات التالية