Kurzanleitung: Erste Schritte mit der Developer Knowledge API

In diesem Leitfaden erfahren Sie, wie Sie die Developer Knowledge API verwenden. Sie erfahren, wie Sie die Developer Knowledge API aktivieren, einen API-Schlüssel abrufen und Ihre ersten API-Aufrufe zum Suchen und Abrufen von Entwicklerdokumentation ausführen.

Hinweis

API aktivieren

  1. Öffnen Sie in der Google APIs-Bibliothek die Seite zur Developer Knowledge API.
  2. Prüfen Sie, ob Sie das richtige Projekt ausgewählt haben, in dem Sie die API verwenden möchten.
  3. Klicken Sie auf Aktivieren. Zum Aktivieren oder Verwenden der API sind keine speziellen IAM-Rollen erforderlich.

API-Schlüssel erstellen und schützen

  1. Rufen Sie in der Google Cloud Console für das Projekt, in dem Sie die API aktiviert haben, die Seite „Anmeldedaten“ auf.
  2. Klicken Sie auf Anmeldedaten erstellen und wählen Sie im Menü die Option API-Schlüssel aus. Das Dialogfeld „API-Schlüssel erstellt“ enthält den String für den neu erstellten Schlüssel.
  3. Klicken Sie auf API-Schlüssel bearbeiten.
  4. Geben Sie im Feld Name einen Namen für den Schlüssel ein.
  5. Wählen Sie unter API-Einschränkungen die Option Schlüssel einschränken aus.
  6. Aktivieren Sie in der Liste APIs auswählen die Developer Knowledge API und klicken Sie auf OK.
    • Hinweis: Wenn Sie die Developer Knowledge API gerade erst aktiviert haben, kann es eine Weile dauern, bis sie in der Liste APIs auswählen angezeigt wird.
  7. Klicken Sie auf Speichern.

Nach Dokumentblöcken suchen

Sobald Sie Ihren Developer Knowledge API-Schlüssel haben, können Sie die API verwenden. Im folgenden Beispiel wird gezeigt, wie Sie nach Dokument-Chunks suchen, die sich auf „BigQuery“ beziehen:

  1. Speichern Sie Ihren Developer Knowledge API-Schlüssel in einer Umgebungsvariablen:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Ersetzen Sie YOUR_API_KEY durch den generierten API-Schlüssel.

  2. Verwenden Sie curl, um den Endpunkt searchDocumentChunks aufzurufen:

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

Dieser Befehl gibt eine Liste von Dokumentblöcken zurück, die der Anfrage entsprechen, einschließlich Snippets aus dem Inhalt und einer parent für jedes Dokument.

Dokument abrufen

Die Antwort von searchDocumentChunks enthält eine Liste von Dokument-Chunks. Jeder Dokumentabschnitt hat ein parent-Feld, mit dem Sie den vollständigen Inhalt des Dokuments mit GetDocument abrufen können.

Kopieren Sie die parent eines der Dokument-Chunks, die vom searchDocumentChunks-Aufruf zurückgegeben wurden (z. B. documents/developers.google.com/...), speichern Sie sie in einer Umgebungsvariablen und rufen Sie den GetDocument-Endpunkt mit curl auf:

export DOC_NAME="DOCUMENT_NAME"

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

Dadurch wird der vollständige Markdown-Inhalt des angegebenen Dokuments zurückgegeben.

Nächste Schritte