GitHub Docs-API

Verwenden Sie die offizielle API zum programmgesteuerten GitHub Docs Auflisten von Seiten, Suchen und Abrufen von GitHub Dokumentationsinhalten.

In diesem Artikel

GitHub Docs bietet mehrere Möglichkeiten, programmgesteuert auf Dokumentationsinhalte zuzugreifen. Sie können einzelne Artikel als Markdown abrufen, alle verfügbaren Seiten auflisten, die Dokumentation durchsuchen oder KI-Agents auf die llms.txt Datei zur Inhaltsermittlung verweisen.

Artikel-Endpunkt

Der Artikelendpunkt gibt den Markdown-Inhalt und die Metadaten einer beliebigen GitHub Docs Seite zurück. Es unterstützt alle Seitentypen, einschließlich Standardartikeln, REST-API-Referenzseiten, GraphQL-Referenzseiten und Zielseiten.

Der Artikel-Endpunkt akzeptiert den folgenden Abfrageparameter:

  • pathname (erforderlich): Der Artikelpfad, einschließlich eines Sprachpräfixes wie /en/ z. B. oder /ja/.
    • Beispiel: /en/get-started/start-your-journey/about-github-and-git

Darüber hinaus akzeptieren GET /api/article und GET /api/article/body den folgenden optionalen Abfrageparameter:

  • apiVersion: Gibt für REST-API-Referenzseiten an, welche API-Version verwendet werden soll. Standardmäßig wird die neueste Version verwendet.

Artikelinhalt wird abgerufen

GET https://docs.github.com/api/article/body gibt den vollständigen Artikelinhalt als Markdown zurück.

curl "https://docs.github.com/api/article/body?pathname=/en/get-started/start-your-journey/about-github-and-git"

Um auf einen Versionsartikel zuzugreifen (z. B. für GitHub Enterprise Cloud), schließen Sie die Version in den Pfad ein:

curl "https://docs.github.com/api/article/body?pathname=/en/enterprise-cloud@latest/admin/overview/about-github-enterprise-cloud"

Abrufen von Artikelmetadaten

GET https://docs.github.com/api/article/meta gibt Metadaten zu einem Artikel als JSON zurück, einschließlich Titel, Einführung, Produktbereich, Dokumenttyp und Breadcrumbs.

curl "https://docs.github.com/api/article/meta?pathname=/en/get-started/start-your-journey/about-github-and-git"

Zusammenkommen von Inhalten und Metadaten

GET https://docs.github.com/api/article gibt Metadaten und den Artikeltext in einer einzigen JSON-Antwort zurück, wobei die Ergebnisse des Textkörpers und der Metaendpunkte kombiniert werden.

curl "https://docs.github.com/api/article?pathname=/en/get-started/start-your-journey/about-github-and-git"

Pagelist-Endpunkt

Der Pagelist-Endpunkt gibt eine Liste aller verfügbaren Seitenpfade für eine bestimmte Sprache und Dokumentationsversion zurück. Sie können es verwenden, um alle Artikel zu entdecken, und dann einzelne Artikel mit dem Artikelendpunkt abzurufen.

Alle Seiten auflisten

GET https://docs.github.com/api/pagelist/:lang/:version gibt eine durch neue Zeile getrennte Liste aller Seitenpfade für die angegebene Sprache und Version zurück.

curl "https://docs.github.com/api/pagelist/en/free-pro-team@latest"

Sprachenliste

GET https://docs.github.com/api/pagelist/languages gibt alle verfügbaren Sprachcodes als JSON zurück. Verwenden Sie diese Option, um gültige Werte für den :lang obigen Parameter zu finden.

Versionsliste

GET https://docs.github.com/api/pagelist/versions gibt alle verfügbaren Dokumentationsversionen als JSON zurück, einschließlich GitHub Enterprise Server Versionsnummern. Verwenden Sie diese Option, um gültige Werte für den :version obigen Parameter zu finden.

Endpunkt für die Suche

Mit dem Suchendpunkt können Sie über alle GitHub Docs Inhalte hinweg suchen. Es gibt Ergebnisse nach Relevanz sortiert mit Hervorhebungen und Metadaten für jede übereinstimmende Seite zurück.

Durchsuchen von Dokumenteninhalten

GET https://docs.github.com/api/search/v1 akzeptiert die folgenden Abfrageparameter:

  • query (erforderlich): Der Suchbegriff.
  • client_name (erforderlich für externe Clients wie curl): Ein Name, der Ihren Client oder Ihre Integration identifiziert.
  • version (optional): Die zu durchsuchende Dokumentationsversion. Wird standardmäßig auf free-pro-team festgelegt. Gültige Werte umfassen free-pro-team, enterprise-cloudund GitHub Enterprise Server Versionsnummern wie 3.19.
  • language (optional): Die zu durchsuchende Sprache. Wird standardmäßig auf en festgelegt.
  • page (optional): Die Seitenzahl für paginierte Ergebnisse. Wird standardmäßig auf 1 festgelegt.
  • size (optional): Die Anzahl der Ergebnisse pro Seite, bis zu einem Maximum von 50. Wird standardmäßig auf 10 festgelegt.
curl "https://docs.github.com/api/search/v1?query=actions&client_name=docs-api-example&version=free-pro-team&language=en"

Die Antwort enthält ein meta Objekt mit Informationen über die Gesamtanzahl der Übereinstimmungen und ein hits Array, das die übereinstimmenden Seiten mit Titeln, URLs, Breadcrumbs und Inhaltshighlights enthält.

llms.txt für KI-Agenten

GitHub Docs veröffentlicht eine llms.txt Datei unter https://docs.github.com/llms.txt, die auf den llms.txt Standard folgt. Diese Datei bietet einen strukturierten Überblick über die Dokumentationswebsite, die zur Nutzung durch LLMs und KI-gestützte Tools konzipiert wurde.

Wenn Sie einen Agenten oder ein Tool erstellen, das auf GitHub Docs zugreifen muss, ist llms.txt der empfohlene Ausgangspunkt, um verfügbare Inhalte und API-Endpunkte zu finden.

Weiterführende Lektüre