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:

• SearchDocumentChunks kann auf Grundlage einer Anfrage relevante Seiten-URIs und Inhaltsausschnitte finden.
• GetDocument oder BatchGetDocuments zum Abrufen des vollständigen Inhalts der Suchergebnisse.
• AnswerQuery, um Antworten auf Anfragen zu generieren, die aus dem Dokumentationskorpus stammen.

Die Developer Knowledge API unterstützt das Suchen und Abrufen von Dokumentationsseiten als unstrukturierte Markdown-Inhalte. Das Korpus mit durchsuchbaren Inhalten ist in der Korpusreferenz aufgeführt.

Einsatzmöglichkeiten 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 der RPC-Referenz.
• Clientbibliotheken: Sie können die Developer Knowledge API mithilfe offizieller Clientbibliotheken für Python, Node.js und TypeScript, Go, Java, PHP und Ruby in Ihre Anwendungen einbinden.
• Google Cloud CLI (gcloud): Führen Sie gcloud developer-knowledge-Befehle über das Terminal aus, um Dokumentabschnitte zu durchsuchen, Markdown-Inhalte abzurufen und Antworten zu generieren.
• Developer Knowledge-MCP-Server: Verbinden Sie Ihren KI-Coding-Assistenten oder -Agenten über MCP-Tools (Model Context Protocol) (search_documents, get_documents und answer_query) mit der Dokumentation von Google. Weitere Informationen finden Sie in der MCP-Referenz.

Tipp :Wenn Sie einen KI-Programmierassistenten verwenden, installieren Sie den retrieving-developer-knowledge-Agent-Skill, indem Sie npx skills add google/skills --skill retrieving-developer-knowledge ausführen. Dieser Skill enthält integrierte Anweisungen für Ihren Assistenten, welches Developer Knowledge MCP-Servertool ausgewählt werden soll, wie Fehler behandelt werden und wie die REST API mit curl aufgerufen wird, wenn der MCP-Server nicht verfügbar ist. Weitere Informationen finden Sie unter Developer Knowledge-Agent-Skill verwenden.

Zwischen API und MCP-Server wählen

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

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

API aktivieren

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

Tipp :Wenn Sie kein Google Cloud-Projekt haben, erstellen Sie eines gemäß der Anleitung für Google Cloud oder Firebase.

1. Öffnen Sie die Seite zur 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 speziellen IAM-Rollen erforderlich.

Authentifizierung

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

• API-Schlüssel: Authentifizieren Sie direkte REST-Anfragen oder den MCP-Server für Entwicklerwissen mit dem Abfrageparameter key oder dem Header X-Goog-Api-Key.
• Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC), OAuth 2.0 oder Dienstkonten: Authentifizieren Sie Anfragen, wenn Sie die offiziellen Clientbibliotheken oder Produktionsworkflows verwenden. Weitere Informationen zum Einrichten von Anmeldedaten finden Sie in der Dokumentation zu Standardanmeldedaten für Anwendungen.
• Nutzeranmeldedaten (gcloud CLI): Authentifizieren Sie CLI-Anfragen, indem Sie sich mit gcloud auth login in Ihrem Google Cloud-Konto anmelden. Eine Anleitung zur Einrichtung finden Sie in der Kurzanleitung zur gcloud CLI.

Enthaltene Dokumentation

Informationen dazu, in welchen Dokumenten die API sucht, finden Sie in der Korpusreferenz.

Die Developer Knowledge API soll Zugriff auf die aktuelle Google-Entwicklerdokumentation 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.
• Inhaltsbereich:Es werden nur öffentliche Seiten in der Corpus-Referenz berücksichtigt. Inhalte aus anderen Quellen wie GitHub, OSS-Websites, Blogs oder YouTube sind nicht enthalten.