Guia de início rápido: começar a usar a API Developer Knowledge

Este guia mostra como começar a usar a API Developer Knowledge. Você vai aprender a ativar a API Developer Knowledge, receber uma chave de API e fazer suas primeiras chamadas de API para pesquisar e recuperar documentação para desenvolvedores.

Antes de começar

Ativar a API

  1. Abra a página da API Developer Knowledge na biblioteca de APIs do Google.
  2. Verifique se você selecionou o projeto correto em que pretende usar a API.
  3. Clique em Ativar. Não é necessário ter papéis específicos do IAM para ativar ou usar a API.

Criar e proteger a chave de API

  1. No console do Google Cloud do projeto em que você ativou a API, acesse a página "Credenciais".
  2. Clique em Criar credenciais e selecione Chave de API no menu. A caixa de diálogo "Chave de API criada" mostra a string da chave recém-criada.
  3. Clique em Editar chave de API.
  4. No campo Nome, digite um nome para a chave.
  5. Em Restrições da API, selecione Restringir chave.
  6. Na lista Selecionar APIs, ative a API Developer Knowledge e clique em OK.
    • Observação: se você acabou de ativar a API Developer Knowledge, pode haver um atraso antes que ela apareça na lista Selecionar APIs.
  7. Clique em Salvar.

Pesquisar partes de documentos

Depois de ter sua chave de API Developer Knowledge, você pode começar a usar a API. O exemplo a seguir mostra como pesquisar partes de documentos relacionadas a "BigQuery":

  1. Salve sua chave de API Developer Knowledge em uma variável de ambiente:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Substitua YOUR_API_KEY pela chave de API que você gerou.

  2. Use curl para chamar o endpoint searchDocumentChunks:

    curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Esse comando retorna uma lista de partes de documentos que correspondem à consulta, incluindo snippets do conteúdo e um parent para cada documento.

Recuperar um documento

A resposta de searchDocumentChunks contém uma lista de partes do documento. Cada parte do documento tem um campo parent, que pode ser usado para recuperar o conteúdo completo do documento com GetDocument.

Copie o parent de um dos trechos de documento retornados pela chamada searchDocumentChunks (por exemplo, documents/developers.google.com/...), salve em uma variável de ambiente e use curl para chamar o endpoint GetDocument:

export DOC_NAME="DOCUMENT_NAME"

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

Isso retorna todo o conteúdo do Markdown do documento especificado.

A seguir