شروع سریع: شروع به کار با API دانش توسعه‌دهندگان

این راهنما به شما نشان می‌دهد که چگونه با Developer Knowledge API شروع به کار کنید. شما یاد خواهید گرفت که چگونه Developer Knowledge API را فعال کنید، یک کلید API دریافت کنید و اولین فراخوانی‌های API خود را برای جستجو و بازیابی اسناد توسعه‌دهنده انجام دهید.

قبل از اینکه شروع کنی

فعال کردن API

  1. صفحه API دانش توسعه‌دهندگان را در کتابخانه APIهای گوگل باز کنید.
  2. بررسی کنید که پروژه‌ی درستی را که قصد دارید در آن از API استفاده کنید، انتخاب کرده‌اید.
  3. روی فعال کردن کلیک کنید. برای فعال کردن یا استفاده از API، به هیچ نقش IAM خاصی نیاز نیست.

کلید API را ایجاد و ایمن کنید

  1. در کنسول گوگل کلود مربوط به پروژه‌ای که API را در آن فعال کرده‌اید، به صفحه اعتبارنامه‌ها (Credentials) بروید.
  2. روی ایجاد اعتبارنامه کلیک کنید و سپس کلید API را از منو انتخاب کنید.
  3. در قسمت نام ، یک نام برای کلید وارد کنید.
  4. روی منوی کشویی «انتخاب محدودیت‌های API» کلیک کنید و سپس عبارت «Developer Knowledge API» را تایپ کنید. روی نتیجه کلیک کنید و سپس روی «تأیید» کلیک کنید.
    • توجه: اگر به تازگی رابط برنامه‌نویسی کاربردی دانش توسعه‌دهندگان (Developer Knowledge API) را فعال کرده‌اید، ممکن است نمایش آن در لیست با تأخیر مواجه شود. چند دقیقه صبر کنید و دوباره امتحان کنید.
  5. روی ایجاد کلیک کنید.

جستجوی تکه‌های سند

وقتی کلید API دانش توسعه‌دهنده خود را دریافت کردید، می‌توانید شروع به استفاده از API کنید. مثال زیر نحوه جستجوی بخش‌هایی از سند مربوط به "BigQuery" را نشان می‌دهد:

  1. کلید 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 سند مشخص شده را برمی‌گرداند.

قدم بعدی چیست؟

  • برای مشاهده لیست کامل مستندات موجود، مرجع Corpus را بررسی کنید.
  • برای جزئیات بیشتر در مورد متدها و پارامترهای API، به مستندات مرجع API مراجعه کنید.