仓库内容的 REST API 端点

获取仓库中文件或目录的内容。使用path参数指定文件路径或目录。如果省略path参数，您将收到仓库根目录的内容。

此端点支持以下自定义媒体类型。更多信息，请参阅“媒体类型”。

• application/vnd.github.raw+json：返回文件和符号链接的原始文件内容。
• application/vnd.github.html+json：以 HTML 格式返回文件内容。使用 GitHub 的开源 Markup 库 将标记语言呈现为 HTML。
• application/vnd.github.object+json：无论内容类型如何，都以一致的对象格式返回内容。例如，对于目录，响应将是一个对象，而不是对象的数组，该对象具有包含对象数组的entries属性。

如果内容是目录，则响应将是对象数组，目录中的每个项目一个对象。列出目录的内容时，子模块的“类型”指定为“文件”。逻辑上，值应为“子模块”。此行为出于向后兼容性目的而存在。在 API 的下一个主要版本中，类型将返回为“子模块”。

如果内容是符号链接，并且符号链接的目标是仓库中的普通文件，则 API 将返回文件的内容。否则，API 将返回一个描述符号链接本身的对象。

如果内容是子模块，则submodule_git_url字段标识子模块仓库的位置，sha字段标识子模块仓库中的特定提交。Git 在克隆子模块仓库时使用给定的 URL，并在该特定提交处检出子模块。如果子模块仓库不是托管在 github.com 上，则 Git URL（git_url和_links["git"]）和 github.com URL（html_url和_links["html"]）将为空值。

备注:

• 要递归获取仓库的内容，您可以递归获取树。
• 此 API 对目录的文件数量上限为 1,000 个。如果您需要检索更多文件，请使用Git 树 API。
• 下载 URL 会过期，并且仅供一次性使用。为了确保下载 URL 不会过期，请使用内容 API 获取每个下载的最新下载 URL。
• 如果请求的文件大小为
  • 1 MB 或更小：支持此端点的所有功能。
  • 1-100 MB 之间：仅支持raw或object自定义媒体类型。两者都将正常工作，但使用object媒体类型时，content字段将为空字符串，encoding字段将为"none"。要获取这些较大的文件的内容，请使用raw媒体类型。
  • 大于 100 MB：不支持此端点。

在仓库中创建一个新文件或替换现有文件。

OAuth 应用令牌和个人访问令牌（经典）需要repo作用域才能使用此端点。还需要workflow作用域才能修改.github/workflows目录中的文件。

删除仓库中的文件。

您可以提供额外的committer参数，这是一个包含提交者信息的 对象。或者，您可以提供一个author参数，这是一个包含作者信息的 对象。

author部分是可选的，如果省略，则使用committer信息填充。如果省略committer信息，则使用已认证用户的 信息。

无论您选择使用author还是committer，都必须为name和email提供值。否则，您将收到422状态码。

获取仓库的首选自述文件。

此端点支持以下自定义媒体类型。更多信息，请参阅“媒体类型”。

• application/vnd.github.raw+json：返回原始文件内容。如果您未指定媒体类型，则为默认值。
• application/vnd.github.html+json：以 HTML 格式返回自述文件。使用 GitHub 的开源 Markup 库 将标记语言呈现为 HTML。

获取仓库目录中的自述文件。

此端点支持以下自定义媒体类型。更多信息，请参阅“媒体类型”。

• application/vnd.github.raw+json：返回原始文件内容。如果您未指定媒体类型，则为默认值。
• application/vnd.github.html+json：以 HTML 格式返回自述文件。使用 GitHub 的开源 Markup 库 将标记语言呈现为 HTML。

获取下载仓库 tar 归档文件的重定向 URL。如果您省略:ref，将使用仓库的默认分支（通常为main）。请确保您的 HTTP 框架已配置为跟踪重定向，否则您需要使用Location标头发出第二个GET请求。

获取下载仓库 zip 归档文件的重定向 URL。如果您省略:ref，将使用仓库的默认分支（通常为main）。请确保您的 HTTP 框架已配置为跟踪重定向，否则您需要使用Location标头发出第二个GET请求。