Skip to main content

Medientypen

Hier erfährst du mehr über Medientypen, um das Format der Daten anzugeben, die du nutzen möchtest.

In der API werden benutzerdefinierte Medientypen verwendet, damit Consumer das Format der Daten auswählen können, die sie empfangen möchten. Dies erfolgt durch Hinzufügen eines oder mehrerer der folgenden Typen zum Accept-Header, wenn du eine Anforderung vornehmen. Medientypen sind ressourcenspezifisch, sodass sie unabhängig voneinander geändert werden können und Formate unterstützen, die von anderen Ressourcen nicht unterstützt werden.

Alle GitHub Enterprise Server-Medientypen sehen wie folgt aus:

application/vnd.github.param[+json]

Die einfachsten Medientypen, die von der API unterstützt werden, sind:

application/vnd.github+json
application/json

Hinweis: In der Vergangenheit wurde empfohlen, v3 in den Accept-Header einzufügen. Dies ist nicht mehr erforderlich und hat keine Auswirkungen auf API-Anforderungen.

Wenn du eine Eigenschaft (wie full oder raw unten) festlegst, füge diese nach github ein:

application/vnd.github.raw+json

Eigenschaften des Kommentartexts

Der Text eines Kommentars kann in GitHub Flavored Markdown geschrieben werden. Die APIs zum Verwalten von Issues, Issuekommentaren, Pull Request-Kommentaren und Gist-Kommentaren unterstützen alle die gleichen Medientypen:

Raw

application/vnd.github.raw+json

Gibt den unformatierten Markdown-Text zurück. Die Antwort enthält body. Dies ist der Standardwert, wenn du keinen bestimmten Medientyp übergibst.

Text

application/vnd.github.text+json

Gibt nur eine Textdarstellung des Markdown-Texts zurück. Die Antwort enthält body_text.

HTML

application/vnd.github.html+json

Gibt HTML zurück, das aus dem Markdown des Texts gerendert wird. Die Antwort enthält body_html.

Vollständig

application/vnd.github.full+json

Gibt Raw-, Text- und HTML-Darstellungen zurück. Die Antwort enthält body, body_text und body_html:

Git-Blobeigenschaften

Die folgenden Medientypen sind beim Abrufen eines Blobs zulässig:

JSON

application/vnd.github+json
application/json

Gibt die JSON-Darstellung des Blobs mit content als eine base64-codierten Zeichenfolge zurück. Dies ist der Standardwert, wenn nichts übergeben wird.

Raw

application/vnd.github.raw

Gibt die unformatierten Blobdaten zurück.

Commits, Commitvergleich und Pull Requests

Die REST-API zum Verwalten von Commits und Pull Requests unterstützt diff- und patch-Formate:

diff

application/vnd.github.diff

patch

application/vnd.github.patch

sha

application/vnd.github.sha

Repository-Inhalt

Raw

application/vnd.github.raw

Gibt die unformatierten Inhalte einer Datei zurück. Dies ist der Standardwert, wenn du keinen bestimmten Medientyp übergibst.

HTML

application/vnd.github.html

Für Markupdateien wie Markdown oder AsciiDoc kannst du den gerenderten HTML-Code mithilfe des Medientyps .html abrufen. Markupsprachen werden mit unserer Open-Source-Markup-Bibliothek in HTML gerendert.

Gists

Raw

application/vnd.github.raw

Gibt die unformatierten Inhalte eines Gists zurück. Dies ist der Standardwert, wenn du keinen bestimmten Medientyp übergibst.

base64

application/vnd.github.base64

Die Gist-Inhalte werden base64-codiert, bevor sie gesendet werden. Dies kann nützlich sein, wenn dein Gist ungültige UTF-8-Sequenzen enthält.