Клиентские библиотеки API знаний для разработчиков

На этой странице показано, как начать работу с облачными клиентскими библиотеками для API знаний разработчиков. Вместо создания необработанных HTTP-запросов, клиентские библиотеки предоставляют идиоматические типы данных, встроенную аутентификацию, автоматическую пагинацию и обработку повторных попыток, что сокращает объем необходимого кода.

Чтобы узнать больше о клиентских библиотеках для API Google, обратитесь к разделу «Объяснение клиентских библиотек» .

Установите клиентскую библиотеку.

Выберите свой язык программирования, чтобы установить официальную клиентскую библиотеку Developer Knowledge API:

Идти

Добавьте модуль в свой проект 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» .

Руби

Установите гем:

gem install google-developers-developer_knowledge

Для получения более подробной информации обратитесь к разделу «Настройка среды разработки Ruby» .

Настройка аутентификации

Перед отправкой запросов к API убедитесь, что в вашем проекте Google Cloud включен API базы знаний для разработчиков .

Для аутентификации вызовов к API базы знаний разработчика клиентские библиотеки поддерживают учетные данные по умолчанию для приложений (ADC) . Библиотеки ищут учетные данные в определенном наборе мест и используют их для аутентификации запросов к API. С помощью ADC вы можете сделать учетные данные доступными для вашего приложения в различных средах, таких как локальная разработка или производственная среда, без необходимости изменения кода приложения.

В производственных средах способ настройки АЦП зависит от используемой службы и контекста:

  • В средах Google Cloud : когда ваше приложение работает в Cloud Run, Google Kubernetes Engine, Compute Engine или Cloud Run Functions, ADC автоматически использует учетную запись службы, привязанную к вычислительному ресурсу.
  • Внешние или локальные среды : используйте федерацию идентификации рабочих нагрузок или установите переменную среды GOOGLE_APPLICATION_CREDENTIALS указав путь к файлу конфигурации учетных данных.

Для получения дополнительной информации о параметрах учетных данных в производственной среде см. раздел «Настройка учетных данных приложения по умолчанию» .

Для локальной среды разработки вы можете настроить ADC, используя учетные данные, связанные с вашей учетной записью Google:

  1. Установите и инициализируйте интерфейс командной строки gcloud.

  2. Создайте локальные учетные данные для аутентификации в вашем аккаунте Google:

    gcloud auth application-default login

    Появляется экран входа в систему. После входа в систему ваши учетные данные сохраняются в локальном файле учетных данных, используемом ADC.

Дополнительные ресурсы

Выберите вкладку с языком, чтобы найти ссылки на справочную документацию по API, примеры кода, рекомендации по использованию, системы отслеживания ошибок и репозитории исходного кода для каждой клиентской библиотеки:

Идти

Ниже приведён список ссылок на дополнительные ресурсы, связанные с клиентской библиотекой для Go:

Java

Ниже приведён список ссылок на дополнительные ресурсы, связанные с клиентской библиотекой для Java:

Node.js и TypeScript

Ниже приведён список ссылок на дополнительные ресурсы, связанные с клиентской библиотекой для Node.js и TypeScript:

PHP

Ниже приведён список ссылок на дополнительные ресурсы, связанные с клиентской библиотекой для PHP:

Python

Ниже приведён список ссылок на дополнительные ресурсы, связанные с клиентской библиотекой для Python:

Руби

Ниже приведён список ссылок на дополнительные ресурсы, связанные с клиентской библиотекой для Ruby:

Что дальше?