Guide de démarrage rapide : Premiers pas avec l'API Developer Knowledge

Ce guide vous explique comment commencer à utiliser l'API Developer Knowledge. Vous allez apprendre à activer l'API Developer Knowledge, à obtenir une clé API et à effectuer vos premiers appels d'API pour rechercher et récupérer de la documentation pour les développeurs.

Avant de commencer

Activer l'API

  1. Ouvrez la page de l'API Developer Knowledge dans la bibliothèque des API Google.
  2. Vérifiez que vous avez sélectionné le bon projet dans lequel vous souhaitez utiliser l'API.
  3. Cliquez sur Activer. Aucun rôle IAM spécifique n'est requis pour activer ou utiliser l'API.

Créer et sécuriser la clé API

  1. Dans la console Google Cloud du projet dans lequel vous avez activé l'API, accédez à la page Identifiants.
  2. Cliquez sur Créer des identifiants, puis sélectionnez Clé API dans le menu. La boîte de dialogue "Clé API créée" affiche la chaîne correspondant à la clé que vous venez de créer.
  3. Cliquez sur Modifier la clé API.
  4. Dans le champ Nom, indiquez un nom pour la clé.
  5. Sous API restrictions (Restrictions liées à l'API), sélectionnez Restrict key (Restreindre la clé).
  6. Dans la liste Sélectionner des API, activez l'API Developer Knowledge, puis cliquez sur OK.
    • Remarque : Si vous venez d'activer l'API Developer Knowledge, il est possible qu'un délai soit nécessaire avant qu'elle n'apparaisse dans la liste Sélectionner des API.
  7. Cliquez sur Enregistrer.

Rechercher des blocs de document

Une fois que vous avez votre clé API Developer Knowledge, vous pouvez commencer à utiliser l'API. L'exemple suivant montre comment rechercher des blocs de documents liés à "BigQuery" :

  1. Enregistrez votre clé API Developer Knowledge dans une variable d'environnement :

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Remplacez YOUR_API_KEY par la clé API que vous avez générée.

  2. Utilisez curl pour appeler le point de terminaison searchDocumentChunks :

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

Cette commande renvoie une liste de blocs de documents correspondant à la requête, y compris des extraits du contenu et un parent pour chaque document.

Récupérer un document

La réponse de searchDocumentChunks contient une liste de blocs de documents. Chaque bloc de document comporte un champ parent que vous pouvez utiliser pour récupérer l'intégralité du contenu du document avec GetDocument.

Copiez le parent de l'un des blocs de document renvoyés par l'appel searchDocumentChunks (par exemple, documents/developers.google.com/...), enregistrez-le dans une variable d'environnement et utilisez curl pour appeler le point de terminaison GetDocument :

export DOC_NAME="DOCUMENT_NAME"

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

Cette méthode renvoie le contenu Markdown complet du document spécifié.

Étape suivante