رابط برنامه‌نویسی کاربردی دانش توسعه‌دهندگان

رابط برنامه‌نویسی کاربردی (API) دانش توسعه‌دهندگان، دسترسی برنامه‌نویسی‌شده به اسناد عمومی توسعه‌دهندگان گوگل را فراهم می‌کند و شما را قادر می‌سازد تا این پایگاه دانش را در برنامه‌ها و گردش‌های کاری خود ادغام کنید.

نمای کلی

رابط برنامه‌نویسی کاربردی دانش توسعه‌دهندگان (Developer Knowledge API) به گونه‌ای طراحی شده است که منبع اصلی برای دسترسی قابل خواندن توسط ماشین به اسناد توسعه‌دهندگان گوگل باشد. این رابط دو عملکرد اصلی ارائه می‌دهد:

  • SearchDocumentChunks برای یافتن URI های صفحه و قطعه کدهای محتوا بر اساس یک پرس و جو.
  • GetDocument یا BatchGetDocuments برای دریافت محتوای کامل نتیجه(های) جستجو.

برای شروع سریع، راهنمای شروع سریع را دنبال کنید.

مجموعه محتوای قابل جستجو در مرجع Corpus فهرست شده است.

یادداشت برای پیش‌نمایش : این نسخه پیش‌نمایش از جستجو و بازیابی صفحات مستندات به عنوان محتوای Markdown بدون ساختار پشتیبانی می‌کند.

فعال کردن API

برای استفاده از رابط برنامه‌نویسی کاربردی دانش توسعه‌دهندگان (Developer Knowledge API)، ابتدا باید آن را برای پروژه گوگل کلود خود فعال کنید.

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

احراز هویت

برای استفاده از API دانش توسعه‌دهندگان، به یک کلید API دانش توسعه‌دهندگان نیاز است. برای ایجاد آن:

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

این کلید API دانش توسعه‌دهنده را در درخواست‌های خود لحاظ کنید. برای مثال، فراخوانی‌های REST باید آن را با استفاده از پارامتر پرس‌وجوی key لحاظ کنند. برای مثال به راهنمای شروع سریع مراجعه کنید.

مستندات گنجانده شده

برای اطلاعات بیشتر در مورد اینکه کدام اسناد توسط API جستجو می‌شوند، به مرجع Corpus مراجعه کنید.

محدودیت‌های شناخته‌شده

  • کیفیت Markdown: Markdown از HTML منبع تولید می‌شود. ممکن است برخی اختلافات یا مشکلات قالب‌بندی وجود داشته باشد.
  • محدوده محتوا: فقط صفحات عمومی در مرجع Corpus گنجانده شده است. محتوای منابع دیگر مانند GitHub، سایت‌های OSS، وبلاگ‌ها یا YouTube شامل نمی‌شود.