Get a repository README for a directory

Gets the README from a repository directory.

READMEs support custom media types for retrieving the raw content or rendered HTML.

{ "_links": { "git": "http://example.com", "html": "http://example.com", "self": "http://example.com" }, "content": "string", "download_url": "http://example.com", "encoding": "string", "git_url": "http://example.com", "html_url": "http://example.com", "name": "string", "path": "string", "sha": "string", "size": 0, "submodule_git_url": "\"git://example.com/defunkt/dotjs.git\"", "target": "\"actual/actual.md\"", "type": "string", "url": "http://example.com" }

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Path 参数

owner

string

必需

repo

string

必需

dir

string

必需

The alternate path to look for a README file

Query 参数

ref

string

可选

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

返回响应

🟢200Response

application/json

Body

Content File

_links

object

必需

git

string <uri> | null

必需

html

string <uri> | null

必需

self

string <uri>

必需

content

string

必需

download_url

string <uri> | null

必需

encoding

string

必需

git_url

string <uri> | null

必需

html_url

string <uri> | null

必需

name

string

必需

path

string

必需

sha

string

必需

size

integer

必需

submodule_git_url

string

可选

示例值:

"git://example.com/defunkt/dotjs.git"

target

string

可选

示例值:

"actual/actual.md"

type

string

必需

url

string <uri>

必需

🟠404404

🟠422422