Developer Knowledge API 用戶端程式庫

本頁說明如何開始使用 Developer Knowledge API 適用的 Cloud 用戶端程式庫。用戶端程式庫提供慣用型別、內建驗證、自動分頁和重試處理機制，可減少您需要編寫的程式碼數量，不必建構原始 HTTP 要求。

如要進一步瞭解 Google API 的用戶端程式庫，請參閱「用戶端程式庫說明」。

安裝用戶端程式庫

選取程式設計語言，安裝官方的 Developer Knowledge API 用戶端程式庫：

Go

將模組新增至 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

詳情請參閱「在 Google Cloud 上使用 PHP」。

Python

使用 pip 安裝套件：

pip install --upgrade google-developer-knowledge

詳情請參閱「設定 Python 開發環境」。

小茹

安裝 Gem：

gem install google-developers-developer_knowledge

詳情請參閱「設定 Ruby 開發環境」。

設定驗證方法

發出 API 要求前，請務必在 Google Cloud 雲端專案中啟用 Developer Knowledge API。

如要驗證向 Developer Knowledge API 發出的呼叫，用戶端程式庫支援應用程式預設憑證 (ADC)。程式庫會在定義的一組位置中尋找憑證，並使用這些憑證驗證向 API 發出的要求。有了 ADC，無需修改應用程式程式碼，就能在各種環境 (例如本機開發環境或正式環境)，為應用程式提供憑證。

在正式環境中，設定 ADC 的方式取決於服務和背景：

  • Google Cloud 環境：應用程式在 Cloud Run、Google Kubernetes Engine、Compute Engine 或 Cloud Run 函式上執行時，ADC 會自動使用附加至運算資源的服務帳戶。
  • 外部或內部部署環境：使用 Workload Identity Federation，或將 GOOGLE_APPLICATION_CREDENTIALS 環境變數設為憑證設定檔的路徑。

如要進一步瞭解正式版憑證選項，請參閱「設定應用程式預設憑證」。

在本機開發環境中，您可以使用與 Google 帳戶相關聯的憑證設定 ADC：

  1. 安裝並初始化 gcloud CLI。

  2. 為 Google 帳戶建立本機驗證憑證：

    gcloud auth application-default login

    登入畫面會隨即顯示。登入後，您的憑證會儲存在 ADC 使用的本機憑證檔案中。

其他資源

選取語言分頁，即可找到各用戶端程式庫的 API 參考文件、程式碼範例、最佳做法、Issue Tracker 和原始碼存放區連結：

Go

下方列出與 Go 用戶端程式庫相關的其他資源連結：

Java

下方列出與 Java 用戶端程式庫相關的其他資源連結：

Node.js 和 TypeScript

下方列出與 Node.js 和 TypeScript 用戶端程式庫相關的其他資源連結：

PHP

下方列出與 PHP 用戶端程式庫相關的其他資源連結：

Python

下方列出與 Python 用戶端程式庫相關的其他資源連結：

小茹

下方列出與 Ruby 用戶端程式庫相關的其他資源連結：

後續步驟