Developer Knowledge API

Die Developer Knowledge API bietet programmatischen Zugriff auf die öffentliche Entwicklerdokumentation von Google. So können Sie diese Wissensdatenbank in Ihre eigenen Anwendungen und Workflows einbinden.

Übersicht

Die Developer Knowledge API ist als kanonische Quelle für den maschinenlesbaren Zugriff auf die Entwicklerdokumentation von Google konzipiert. Sie bietet Funktionen zum Suchen und Abrufen von Dokumenten sowie zum Beantworten von Anfragen:

Mit der Developer Knowledge API können Sie Dokumentationsseiten als unstrukturierte Markdown-Inhalte suchen und abrufen. Das Corpus der durchsuchbaren Inhalte ist in der Corpus-Referenz aufgeführt.

Möglichkeiten zur Nutzung von Developer Knowledge

Je nach Workflow können Sie über die folgenden Oberflächen auf Developer Knowledge zugreifen:

  • REST API und RPC API: Rufen Sie die HTTP- oder gRPC-Endpunkte direkt auf. Methodenspezifikationen finden Sie in der REST-Referenz und RPC-Referenz.
  • Clientbibliotheken: Binden Sie die Developer Knowledge API mit offiziellen Clientbibliotheken für C#, Go, Java, Node.js und TypeScript, PHP, Python und Ruby in Ihre Anwendungen ein.
  • Google Cloud CLI (gcloud): Führen Sie gcloud developer-knowledge Befehle über das Terminal aus, um Dokumentchunks zu suchen, Markdown-Inhalte abzurufen und Antworten zu generieren.
  • MCP-Server für Entwicklerwissen: Verbinden Sie Ihren KI-Programmierassistenten oder -Agenten mit der Dokumentation von Google. Verwenden Sie dazu die MCP-Tools (Model Context Protocol) (search_documents, get_documents, und answer_query). Weitere Informationen finden Sie in der MCP-Referenz.

Zwischen API und MCP-Server wählen

Die Developer Knowledge API und der MCP-Server für Entwicklerwissen sind für unterschiedliche Integrationsanforderungen konzipiert:

  • Verwenden Sie die Developer Knowledge API, Clientbibliotheken oder die gcloud CLI, wenn:
    • Ihr Projekt keinen KI-Agenten verwendet.
    • Sie benutzerdefinierte Tools oder Toolsets für Ihren Agenten definieren möchten.
    • Sie Ergebnisse verarbeiten oder kombinieren möchten, bevor Sie sie an ein Modell übergeben (z. B. die Byte-Länge des Dokuments prüfen, bevor Sie den vollständigen Inhalt abrufen).
    • Sie Suchergebnisse filtern (z. B. nach data_source oder update_time) oder Feldmasken anwenden müssen.
  • Verwenden Sie den MCP-Server für Entwicklerwissen und die Agent-Fähigkeit , wenn:
    • Sie einen KI-Programmierassistenten oder -Agenten verbinden möchten, ohne benutzerdefinierte Tooldefinitionen und -beschreibungen zu schreiben.
    • Sie automatische Updates wünschen, wenn der MCP-Server für Entwicklerwissen neue Funktionen hinzufügt.
    • Sie keine benutzerdefinierte Metadatenfilterung für Suchergebnisse benötigen.

API aktivieren

Damit Sie die Developer Knowledge API verwenden können, müssen Sie sie zuerst für Ihr Google Cloud-Projekt aktivieren.

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

Authentifizierung

Sie können Anfragen an die Developer Knowledge API mit einer der folgenden Methoden authentifizieren:

OAuth-Bereiche

Bei der Authentifizierung mit OAuth 2.0 oder Dienstkonten akzeptieren die Developer Knowledge API und der MCP-Server für Entwicklerwissen die folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/cloud-platform: Standardbereich, der von Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC), der gcloud CLI und offiziellen Google Cloud-Clientbibliotheken verwendet wird.
  • https://www.googleapis.com/auth/devprofiles.full_control: Bereich, der für OAuth 2.0-Zustimmungsabläufe für Nutzer und MCP-Serverintegrationen verwendet wird.
  • https://www.googleapis.com/auth/developerprofiles.readonly: Lesezugriffsbereich, der für Dienstkonten und Anmeldedaten unterstützt wird, für die kein OAuth-Zustimmungsbildschirm für Endnutzer erforderlich ist.

Autorisierung mit Inhabertoken

Wenn Sie direkte REST-Anfragen mit einem Dienstkonto oder einem OAuth 2.0-Zugriffstoken authentifizieren möchten, übergeben Sie das Token im Header Authorization: Bearer und geben Sie Ihr Abrechnungsprojekt in X-Goog-User-Project an:

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Ersetzen Sie PROJECT_ID durch Ihre Google Cloud-Projekt-ID.

Bei Python-, Node.js-, Go- und Java-Anwendungen werden Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) und Tokenaktualisierungen automatisch von den offiziellen Clientbibliotheken verarbeitet. Beispiele finden Sie unter Clientbibliotheken mit der Developer Knowledge API verwenden.

Enthaltene Dokumentation

In der Corpus-Referenz finden Sie Informationen dazu, welche Dokumente von der API durchsucht werden.

Die Developer Knowledge API soll Zugriff auf die neueste Entwicklerdokumentation von Google bieten. Wir möchten Inhalte innerhalb von 48 Stunden nach der Veröffentlichung neu indexieren, damit neue oder aktualisierte Dokumentation innerhalb von zwei Arbeitstagen verfügbar ist.

Bekannte Einschränkungen

  • Markdown-Qualität:Das Markdown wird aus dem Quell-HTML generiert. Es kann zu Abweichungen oder Formatierungsproblemen kommen.
  • Umfang der Inhalte: Es sind nur öffentliche Seiten in der Corpus-Referenz enthalten. Inhalte aus anderen Quellen wie GitHub, OSS-Websites, Blogs oder YouTube sind nicht enthalten.