Guía de inicio rápido: empezar a usar la API Developer Knowledge

En esta guía se explica cómo empezar a usar la API Developer Knowledge. Aprenderás a habilitar la API Developer Knowledge, obtener una clave de API y hacer tus primeras llamadas a la API para buscar y obtener documentación para desarrolladores.

Antes de empezar

Habilitar la API

  1. Abre la página de la API Developer Knowledge en la biblioteca de APIs de Google.
  2. Comprueba que hayas seleccionado el proyecto correcto en el que quieres usar la API.
  3. Haz clic en Habilitar. No se necesitan roles de gestión de identidades y accesos específicos para habilitar o usar la API.

Crear y proteger la clave de API

  1. En la consola de Google Cloud del proyecto en el que has habilitado la API, ve a la página Credenciales.
  2. Haz clic en Crear credenciales y, a continuación, selecciona Clave de API en el menú. En el cuadro de diálogo de la clave de API creada, se muestra la cadena de la clave que acabas de crear.
  3. Haz clic en Editar clave de API.
  4. En el campo Nombre, asigna un nombre a la clave.
  5. En Restricciones de API, selecciona Restringir clave.
  6. En la lista Seleccionar APIs, habilita API Developer Knowledge y haz clic en Aceptar.
    • Nota: Si acabas de habilitar la API Developer Knowledge, puede que tarde un poco en aparecer en la lista Seleccionar APIs.
  7. Haz clic en Guardar.

Buscar fragmentos de documentos

Cuando tengas tu clave de API Developer Knowledge, podrás empezar a usar la API. En el siguiente ejemplo se muestra cómo buscar fragmentos de documentos relacionados con "BigQuery":

  1. Guarda tu clave de API Developer Knowledge en una variable de entorno:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Sustituye YOUR_API_KEY por la clave de API que has generado.

  2. Usa curl para llamar al endpoint searchDocumentChunks:

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

Este comando devuelve una lista de fragmentos de documentos que coinciden con la consulta, incluidos fragmentos del contenido y un parent por cada documento.

Recuperar un documento

La respuesta de searchDocumentChunks contiene una lista de fragmentos de documentos. Cada fragmento de documento tiene un campo parent, que puedes usar para recuperar el contenido completo del documento con GetDocument.

Copia el parent de uno de los fragmentos de documento devueltos por la llamada searchDocumentChunks (por ejemplo, documents/developers.google.com/...), guárdalo en una variable de entorno y usa curl para llamar al endpoint GetDocument:

export DOC_NAME="DOCUMENT_NAME"

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

Devuelve el contenido completo de Markdown del documento especificado.

Siguientes pasos