快速入门：开始使用 Developer Knowledge API

本指南介绍了如何开始使用 Developer Knowledge API。您将学习如何启用 Developer Knowledge API、获取 API 密钥，以及发出第一个 API 调用来搜索和检索开发者文档。

准备工作

启用 API

  1. 在 Google API 库中打开 Developer Knowledge API 页面。
  2. 检查您是否已选择要使用相应 API 的正确项目。
  3. 点击启用。启用或使用该 API 不需要任何特定的 IAM 角色。

创建并保护 API 密钥

  1. 在您启用该 API 的项目的 Google Cloud 控制台中，前往“凭据”页面。
  2. 点击创建凭证，然后从菜单中选择 API 密钥。“API 密钥已创建”对话框会显示新创建的密钥的字符串。
  3. 点击修改 API 密钥。
  4. 在名称字段中，提供密钥的名称。
  5. 在 API restrictions 下，选择 Restrict key。
  6. 在选择 API 列表中，启用 Developer Knowledge API，然后点击确定。
    • 注意：如果您刚刚启用了 Developer Knowledge API，则该 API 可能需要过一段时间才会显示在选择 API 列表中。
  7. 点击保存。

搜索文档块

获得 Developer Knowledge API 密钥后，您就可以开始使用该 API 了。以下示例展示了如何搜索与“BigQuery”相关的文档块：

  1. 将 Developer Knowledge 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 检索文档的完整内容。

复制 searchDocumentChunks 调用返回的某个文档块的 parent（例如 documents/developers.google.com/...），将其保存到环境变量中，然后使用 curl 调用 GetDocument 端点：

export DOC_NAME="DOCUMENT_NAME"

curl "https://developerknowledge.googleapis.com/v1alpha/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

此方法会返回指定文档的完整 Markdown 内容。

后续步骤