Get repository content

Gets the contents of a file or directory in a repository. Specify the file path or directory in :path. If you omit
:path, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories.

Files and symlinks support a custom media type for
retrieving the raw content or rendered HTML (when supported). All content types support a custom media
type to ensure the content is returned in a consistent
object format.

Note:

To get a repository's contents recursively, you can recursively get the tree.

This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the Git Trees
API.

This API supports files up to 1 megabyte in size.

If the content is a directory

The response will be an array of objects, one object for each item in the directory.
When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value
should be "submodule". This behavior exists in API v3 for backwards compatibility purposes.
In the next major version of the API, the type will be returned as "submodule".

If the content is a symlink

If the requested :path points to a symlink, and the symlink's target is a normal file in the repository, then the
API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object
describing the symlink itself.

If the content is a submodule

The submodule_git_url identifies the location of the submodule repository, and the sha identifies a specific
commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out
the submodule at that specific commit.

If the submodule repository is not hosted on github.com, the Git URLs (git_url and _links["git"]) and the
github.com URLs (html_url and _links["html"]) will have null values.

[ { "_links": { "git": "http://example.com", "html": "http://example.com", "self": "http://example.com" }, "content": "string", "download_url": "http://example.com", "git_url": "http://example.com", "html_url": "http://example.com", "name": "string", "path": "string", "sha": "string", "size": 0, "type": "string", "url": "http://example.com" } ]

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Path 参数

owner

string

必需

repo

string

必需

path

string

必需

path parameter

Query 参数

ref

string

可选

The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

返回响应

🟢200Response

application/json

Body

可选

One of

Content Directory

Content File

Symlink Content

A list of directory items

_links

object

必需

content

string

可选

download_url

string <uri> | null

必需

git_url

string <uri> | null

必需

html_url

string <uri> | null

必需

name

string

必需

path

string

必需

sha

string

必需

size

integer

必需

type

string

必需

url

string <uri>

必需

🔵302302

🟠403403

🟠404404

Get repository content

If the content is a directory#

If the content is a symlink#

If the content is a submodule#

请求参数

返回响应

If the content is a directory

If the content is a symlink

If the content is a submodule