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 um anhand einer Anfrage relevante Seiten-URIs und Content-Snippets zu finden.
• GetDocument oder BatchGetDocuments zum Abrufen des vollständigen Inhalts der Suchergebnisse.
• AnswerQuery, um Antworten auf Anfragen zu generieren, die aus dem Dokumentationskorpus stammen.

Eine Kurzanleitung finden Sie hier.

Das Korpus der durchsuchbaren Inhalte ist in der Korpusreferenz aufgeführt.

Die Developer Knowledge API unterstützt das Suchen und Abrufen von Dokumentationsseiten als unstrukturierte Markdown-Inhalte.

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. Folgen Sie dazu 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 mit dem Abfrageparameter key oder dem Header X-Goog-Api-Key. Ein Beispiel finden Sie in der REST-Kurzanleitung.
• 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.

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.