Skip to main content

媒体类型

了解用于指定要使用的数据格式的媒体类型。

自定义媒体类型在 API 中用于让使用者选择他们希望接收的数据格式。 此功能通过在发出请求时将以下一种或多种类型添加到 Accept 标头中来实现。 媒体类型特定于资源,可以进行独立更改并支持其他资源不支持的格式。

所有 GitHub 媒体类型如下所示:

application/vnd.github.param[+json]

API 支持的最基本媒体类型是:

application/vnd.github+json
application/json

注意: 过去,我们建议在 Accept 标头中包含 v3 。 这不再是必需的,不会影响您的 API 请求。

如果你要指定一个属性(例如下面定义的 full/raw/etc), 将其放在 github 之后:

application/vnd.github.raw+json

注释正文属性

注释正文可采用 GitHub Flavored Markdown 编写,议题议题注释拉取请求注释gist 注释 API 都接受以下媒体类型:

Raw

application/vnd.github.raw+json

返回原始 Markdown 正文。 响应将包含 body。 这是在不传递任何特定媒体类型时的默认值。

Text

application/vnd.github.text+json

返回 Markdown 正文的纯文本表示形式。 响应将包含 body_text

HTML

application/vnd.github.html+json

返回从正文的 Markdown 中渲染的 HTML。 响应将包含 body_html

Full

application/vnd.github.full+json

返回 raw、text 和 HTML 表示形式。 响应将包含 bodybody_textbody_html

Git blob 属性

获取 Blob 时允许使用以下媒体类型:

JSON

application/vnd.github+json
application/json

返回 blob 的 JSON 表示形式,content 为 base64 编码的字符串。 这是在未传递任何参数时的默认值。

Raw

application/vnd.github.raw

返回原始 blob 数据。

提交、提交比较和拉取请求

提交 API拉取请求 API 支持 diffpatch 格式:

差异

application/vnd.github.diff

patch

application/vnd.github.patch

sha

application/vnd.github.sha

仓库内容

Raw

application/vnd.github.raw

返回文件的原始内容。 这是在不传递任何特定媒体类型时的默认值。

HTML

application/vnd.github.html

对于 Markdown 或 AsciiDoc 等标记文件,您可以使用 .html 媒体类型检索渲染的 HTML。 使用我们的开源标记库将标记语言渲染为 HTML。

Gist

Raw

application/vnd.github.raw

返回 gist 的原始内容。 这是在不传递任何特定媒体类型时的默认值。

base64

application/vnd.github.base64

Gist 内容在发送前经过 base64 编码。 这在 gist 包含任何无效的 UTF-8 序列时非常有用。