این صفحه نحوه شروع به کار با کتابخانههای کلاینت ابری برای رابط برنامهنویسی کاربردی دانش توسعهدهندگان (Developer Knowledge API) را نشان میدهد. کتابخانههای کلاینت به جای ساخت درخواستهای خام HTTP، انواع اصطلاحی، احراز هویت داخلی، صفحهبندی خودکار و مدیریت تلاش مجدد را ارائه میدهند که میزان کدی را که باید بنویسید کاهش میدهد.
برای کسب اطلاعات بیشتر در مورد کتابخانههای کلاینت برای APIهای گوگل، به توضیح کتابخانههای کلاینت مراجعه کنید.
کتابخانه کلاینت را نصب کنید
زبان برنامهنویسی خود را برای نصب کتابخانه کلاینت رسمی Developer Knowledge API انتخاب کنید:
برو
ماژول را به پروژه Go خود اضافه کنید:
go get cloud.google.com/go/developerknowledge/apiv1
برای کسب اطلاعات بیشتر، به «راهاندازی محیط توسعه Go» مراجعه کنید.
جاوا
اگر از 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'
برای کسب اطلاعات بیشتر، به «راهاندازی محیط توسعه جاوا» مراجعه کنید.
Node.js و TypeScript
بسته را با استفاده از npm نصب کنید:
npm install @google/developer-knowledge
برای کسب اطلاعات بیشتر، به «راهاندازی محیط توسعه Node.js» مراجعه کنید.
پی اچ پی
بسته را با استفاده از Composer نصب کنید:
composer require google/developer-knowledge
برای کسب اطلاعات بیشتر، به استفاده از PHP در Google Cloud مراجعه کنید.
پایتون
بسته را با استفاده از pip نصب کنید:
pip install --upgrade google-developer-knowledge
برای کسب اطلاعات بیشتر، به «راهاندازی محیط توسعه پایتون» مراجعه کنید.
روبی
جواهر را نصب کنید:
gem install google-developers-developer_knowledge
برای کسب اطلاعات بیشتر، به «راه اندازی محیط توسعه روبی» مراجعه کنید.
تنظیم احراز هویت
قبل از ارسال درخواستهای API، مطمئن شوید که Developer Knowledge API را در پروژه Google Cloud خود فعال کردهاید .
برای احراز هویت فراخوانیها به API دانش توسعهدهندگان، کتابخانههای کلاینت از اعتبارنامههای پیشفرض برنامه (ADC) پشتیبانی میکنند. این کتابخانهها به دنبال اعتبارنامهها در مجموعهای از مکانهای تعریفشده میگردند و از آن اعتبارنامهها برای احراز هویت درخواستها به API استفاده میکنند. با ADC، میتوانید اعتبارنامهها را در محیطهای مختلف، مانند توسعه یا تولید محلی، بدون نیاز به تغییر کد برنامه خود، در دسترس برنامه خود قرار دهید.
برای محیطهای عملیاتی، نحوهی تنظیم ADC به سرویس و زمینهی آن بستگی دارد:
- محیطهای ابری گوگل : وقتی برنامه شما روی توابع Cloud Run، Google Kubernetes Engine، Compute Engine یا Cloud Run اجرا میشود، ADC بهطور خودکار از حساب سرویس متصل به منبع محاسباتی استفاده میکند.
- محیطهای خارجی یا داخلی : از Workload Identity Federation استفاده کنید یا متغیر محیطی
GOOGLE_APPLICATION_CREDENTIALSرا روی مسیر فایل پیکربندی اعتبارنامه تنظیم کنید.
برای کسب اطلاعات بیشتر در مورد گزینههای اعتبارنامههای عملیاتی، به «تنظیم اعتبارنامههای پیشفرض برنامه» مراجعه کنید.
برای یک محیط توسعه محلی، میتوانید ADC را با اعتبارنامههای مرتبط با حساب Google خود تنظیم کنید:
- رابط خط فرمان gcloud را نصب و راهاندازی کنید .
اعتبارنامههای احراز هویت محلی را برای حساب گوگل خود ایجاد کنید:
gcloud auth application-default loginصفحه ورود به سیستم ظاهر میشود. پس از ورود، اطلاعات کاربری شما در فایل اطلاعات کاربری محلی که توسط ADC استفاده میشود، ذخیره میشود.
منابع اضافی
برای یافتن لینکهایی به مستندات مرجع API، نمونههای کد، بهترین شیوهها، ردیابهای مشکل و مخازن کد منبع برای هر کتابخانه کلاینت، یک برگه زبان را انتخاب کنید:
برو
لیست زیر شامل پیوندهایی به منابع بیشتر مربوط به کتابخانه کلاینت برای Go است:
جاوا
لیست زیر شامل پیوندهایی به منابع بیشتر مربوط به کتابخانه کلاینت برای جاوا است:
Node.js و TypeScript
لیست زیر شامل پیوندهایی به منابع بیشتر مربوط به کتابخانه کلاینت برای Node.js و TypeScript است:
پی اچ پی
لیست زیر شامل پیوندهایی به منابع بیشتر مربوط به کتابخانه کلاینت برای PHP است:
پایتون
لیست زیر شامل پیوندهایی به منابع بیشتر مربوط به کتابخانه کلاینت برای پایتون است:
روبی
لیست زیر شامل پیوندهایی به منابع بیشتر مربوط به کتابخانه کلاینت برای روبی است:
قدم بعدی چیست؟
- برای مشاهده و اجرای نمونههای کد برای
AnswerQuery،SearchDocumentChunks،GetDocumentوBatchGetDocuments، از راهنمای سریع کتابخانههای کلاینت استفاده کنید. - درباره فیلترهای پرسوجو، صفحهبندی و ماسکهای فیلد در «جستجو و بازیابی اسناد» بیشتر بیاموزید.
- از تولید مبتنی بر داده با استفاده از «تولید پاسخها از مستندات» استفاده کنید.
- استراتژیهای تلاش مجدد و کدهای وضعیت را در مدیریت خطا، محدود کردن سرعت و مدیریت سهمیه مرور کنید.
- برای مشاهده همه دامنههای مستندات پشتیبانیشده، به مرجع مجموعه مراجعه کنید.