我们经常发布文档更新，此页面的翻译可能仍在进行中。有关最新信息，请访问英文文档。如果此页面上的翻译有问题，请告诉我们。
简体中文
未找到结果.

按产品浏览

REST API
  • Get started
  • Account and profile
  • Authentication
  • Repositories
  • GitHub
  • Enterprise administrators
  • Billing and payments
  • Organizations
  • Code security
  • GitHub Issues
  • GitHub Actions
  • GitHub Codespaces
  • GitHub Packages
  • Search on GitHub
  • Developers
  • REST API
  • GraphQL API
  • GitHub CLI
  • GitHub Discussions
  • GitHub Sponsors
  • Building communities
  • GitHub Pages
  • Education
  • GitHub Desktop
  • Atom
  • Electron
  • CodeQL
  • npm
    • 简体中文
  • English
  • 简体中文 (Simplified Chinese)
  • 日本語 (Japanese)
  • Español (Spanish)
  • Português do Brasil (Portuguese)

    • 此版本的 GitHub Enterprise 已停止服务 2021-09-23. 即使针对重大安全问题，也不会发布补丁。 要获得更好的性能、改进的安全性和新功能，请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助，请联系 GitHub Enterprise 支持。

    Article version

    本文内容

    Gist

    The Gists API enables the authorized user to list, create, update and delete the public gists on GitHub Enterprise Server.

    身份验证

    您可以匿名读取公开 Gist 并为没有令牌的匿名用户创建它们。 要代表用户读取或写入 Gist，您需要 Gist OAuth 作用域和令牌。 更多信息请参阅“OAuth 应用程序的作用域”。

    截断

    Gist API 为 Gist 中的每个文件提供最多一兆字节的内容。 通过 API 返回的每个 Gist 文件都有一个名为 truncated 的键。 如果 truncated 为 true，则说明文件太大，content 中只返回部分内容。

    如果您需要文件的全部内容，您可以向 raw_url 指定的 URL 提出 GET 请求。 请注意，对于超过十兆字节的文件，您需要通过 git_pull_url 提供的 URL 克隆 Gist。

    除了特定文件的内容被截断外，如果文件总数超过 300 个，则整个文件列表也可能被截断。 如果顶层 truncated 键为 true，则说明文件列表中只返回了前 300 个文件。 如果需要获取 Gist 的所有文件，您需要通过 git_pull_url 提供的 URL 克隆 Gist。

    Gist 的自定义媒体类型

    以下是获取 Gist 内容所支持的媒体类型。

    application/vnd.github.VERSION.raw
application/vnd.github.VERSION.base64

    更多信息请参阅“媒体类型”。

    List gists for the authenticated user

    Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

    get /gists

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    since string query

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists')

    Response

    Status: 200 OK
    [
  {
    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Create a gist

    Allows you to add a new gist with one or more files.

    Note: Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

    post /gists

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    description string body

    Description of the gist
    files object body

    Required. Names and content for the files that make up the gist
    public boolean or string body

    Flag indicating whether the gist is public

    代码示例

    Shell
    curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists \
  -d '{"files":{}}'
    JavaScript (@octokit/core.js)
    await octokit.request('POST /gists', {
  files: {}
})

    Response

    Status: 201 Created
    {
  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
  "id": "aa5a315d61ae9438b18d",
  "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
  "created_at": "2010-04-14T02:15:15Z",
  "updated_at": "2011-06-20T11:34:15Z",
  "description": "Hello World Examples",
  "comments": 0,
  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/"
}

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Validation failed

    Status: 422 Unprocessable Entity

    List public gists

    List public gists sorted by most recently updated to least recently updated.

    Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

    get /gists/public

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    since string query

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/public
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/public')

    Response

    Status: 200 OK
    [
  {
    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Validation failed

    Status: 422 Unprocessable Entity

    List starred gists

    List the authenticated user's starred gists:

    get /gists/starred

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    since string query

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/starred
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/starred')

    Response

    Status: 200 OK
    [
  {
    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]

    Not modified

    Status: 304 Not Modified

    Requires authentication

    Status: 401 Unauthorized

    Forbidden

    Status: 403 Forbidden

    Get a gist 

    get /gists/{gist_id}

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/{gist_id}', {
  gist_id: 'gist_id'
})

    Response

    Status: 200 OK
    {
  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
  "id": "aa5a315d61ae9438b18d",
  "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
  "created_at": "2010-04-14T02:15:15Z",
  "updated_at": "2011-06-20T11:34:15Z",
  "description": "Hello World Examples",
  "comments": 0,
  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/"
}

    Not modified

    Status: 304 Not Modified

    Forbidden Gist

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Update a gist

    Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

    patch /gists/{gist_id}

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    description string body

    Description of the gist
    files object body

    Names of files to be updated

    代码示例

    Shell
    curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID \
  -d '{"description":"description"}'
    JavaScript (@octokit/core.js)
    await octokit.request('PATCH /gists/{gist_id}', {
  gist_id: 'gist_id',
  description: 'description'
})

    Response

    Status: 200 OK
    {
  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
  "id": "aa5a315d61ae9438b18d",
  "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
  "created_at": "2010-04-14T02:15:15Z",
  "updated_at": "2011-06-20T11:34:15Z",
  "description": "Hello World Examples",
  "comments": 0,
  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/"
}

    Resource not found

    Status: 404 Not Found

    Validation failed

    Status: 422 Unprocessable Entity

    Delete a gist 

    delete /gists/{gist_id}

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter

    代码示例

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /gists/{gist_id}', {
  gist_id: 'gist_id'
})

    Response

    Status: 204 No Content

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    List gist commits 

    get /gists/{gist_id}/commits

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/commits
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/{gist_id}/commits', {
  gist_id: 'gist_id'
})

    Response

    Status: 200 OK
    [
  {
    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f",
    "version": "57a7f021a713b1c5a6a199b54cc514735d2d462f",
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "change_status": {
      "deletions": 0,
      "additions": 180,
      "total": 180
    },
    "committed_at": "2010-04-14T02:15:15Z"
  }
]

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    List gist forks 

    get /gists/{gist_id}/forks

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/{gist_id}/forks', {
  gist_id: 'gist_id'
})

    Response

    Status: 200 OK
    [
  {
    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 1,
    "user": null,
    "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    }
  }
]

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Fork a gist

    Note: This was previously /gists/:gist_id/fork.

    post /gists/{gist_id}/forks

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter

    代码示例

    Shell
    curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/forks
    JavaScript (@octokit/core.js)
    await octokit.request('POST /gists/{gist_id}/forks', {
  gist_id: 'gist_id'
})

    Response

    Status: 201 Created
    {
  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
  "id": "aa5a315d61ae9438b18d",
  "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
  "files": {
    "hello_world.rb": {
      "filename": "hello_world.rb",
      "type": "application/x-ruby",
      "language": "Ruby",
      "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
      "size": 167
    }
  },
  "public": true,
  "created_at": "2010-04-14T02:15:15Z",
  "updated_at": "2011-06-20T11:34:15Z",
  "description": "Hello World Examples",
  "comments": 0,
  "user": null,
  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
  "owner": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "truncated": false
}

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Validation failed

    Status: 422 Unprocessable Entity

    Check if a gist is starred 

    get /gists/{gist_id}/star

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/{gist_id}/star', {
  gist_id: 'gist_id'
})

    Response if gist is starred

    Status: 204 No Content

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Not Found if gist is not starred

    Status: 404 Not Found

    Star a gist

    Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."

    put /gists/{gist_id}/star

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter

    代码示例

    Shell
    curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    JavaScript (@octokit/core.js)
    await octokit.request('PUT /gists/{gist_id}/star', {
  gist_id: 'gist_id'
})

    Response

    Status: 204 No Content

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Unstar a gist 

    delete /gists/{gist_id}/star

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter

    代码示例

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/star
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /gists/{gist_id}/star', {
  gist_id: 'gist_id'
})

    Response

    Status: 204 No Content

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Get a gist revision 

    get /gists/{gist_id}/{sha}

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    sha string path

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/SHA
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/{gist_id}/{sha}', {
  gist_id: 'gist_id',
  sha: 'sha'
})

    Response

    Status: 200 OK
    {
  "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
  "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
  "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
  "id": "aa5a315d61ae9438b18d",
  "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
  "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
  "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
  "created_at": "2010-04-14T02:15:15Z",
  "updated_at": "2011-06-20T11:34:15Z",
  "description": "Hello World Examples",
  "comments": 0,
  "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/"
}

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Validation failed

    Status: 422 Unprocessable Entity

    List gists for a user

    Lists public gists for the specified user:

    get /users/{username}/gists

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    username string path
    since string query

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/users/USERNAME/gists
    JavaScript (@octokit/core.js)
    await octokit.request('GET /users/{username}/gists', {
  username: 'username'
})

    Response

    Status: 200 OK
    [
  {
    "url": "https://api.github.com/gists/aa5a315d61ae9438b18d",
    "forks_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/forks",
    "commits_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/commits",
    "id": "aa5a315d61ae9438b18d",
    "node_id": "MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk",
    "git_pull_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "git_push_url": "https://gist.github.com/aa5a315d61ae9438b18d.git",
    "html_url": "https://gist.github.com/aa5a315d61ae9438b18d",
    "files": {
      "hello_world.rb": {
        "filename": "hello_world.rb",
        "type": "application/x-ruby",
        "language": "Ruby",
        "raw_url": "https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb",
        "size": 167
      }
    },
    "public": true,
    "created_at": "2010-04-14T02:15:15Z",
    "updated_at": "2011-06-20T11:34:15Z",
    "description": "Hello World Examples",
    "comments": 0,
    "user": null,
    "comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
    "owner": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "truncated": false
  }
]

    Validation failed

    Status: 422 Unprocessable Entity

    评论

    Gist 评论的自定义媒体类型

    以下是 Gist 评论支持的媒体类型。

    application/vnd.github.VERSION.raw
application/vnd.github.VERSION.base64

    有关媒体类型的更多信息，请参阅“自定义媒体类型”。

    List gist comments 

    get /gists/{gist_id}/comments

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    per_page integer query

    Results per page (max 100)

    Default: 30
    page integer query

    Page number of the results to fetch.

    Default: 1

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/comments
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/{gist_id}/comments', {
  gist_id: 'gist_id'
})

    Response

    Status: 200 OK
    [
  {
    "id": 1,
    "node_id": "MDExOkdpc3RDb21tZW50MQ==",
    "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
    "body": "Just commenting for the sake of commenting",
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2011-04-18T23:23:56Z",
    "updated_at": "2011-04-18T23:23:56Z",
    "author_association": "COLLABORATOR"
  }
]

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Create a gist comment 

    post /gists/{gist_id}/comments

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    body string body

    Required. The comment text.

    代码示例

    Shell
    curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/comments \
  -d '{"body":"body"}'
    JavaScript (@octokit/core.js)
    await octokit.request('POST /gists/{gist_id}/comments', {
  gist_id: 'gist_id',
  body: 'body'
})

    Response

    Status: 201 Created
    {
  "id": 1,
  "node_id": "MDExOkdpc3RDb21tZW50MQ==",
  "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
  "body": "Just commenting for the sake of commenting",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2011-04-18T23:23:56Z",
  "updated_at": "2011-04-18T23:23:56Z",
  "author_association": "COLLABORATOR"
}

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Get a gist comment 

    get /gists/{gist_id}/comments/{comment_id}

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    comment_id integer path

    comment_id parameter

    代码示例

    Shell
    curl \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    JavaScript (@octokit/core.js)
    await octokit.request('GET /gists/{gist_id}/comments/{comment_id}', {
  gist_id: 'gist_id',
  comment_id: 42
})

    Response

    Status: 200 OK
    {
  "id": 1,
  "node_id": "MDExOkdpc3RDb21tZW50MQ==",
  "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
  "body": "Just commenting for the sake of commenting",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2011-04-18T23:23:56Z",
  "updated_at": "2011-04-18T23:23:56Z",
  "author_association": "COLLABORATOR"
}

    Not modified

    Status: 304 Not Modified

    Forbidden Gist

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found

    Update a gist comment 

    patch /gists/{gist_id}/comments/{comment_id}

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    comment_id integer path

    comment_id parameter
    body string body

    Required. The comment text.

    代码示例

    Shell
    curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42 \
  -d '{"body":"body"}'
    JavaScript (@octokit/core.js)
    await octokit.request('PATCH /gists/{gist_id}/comments/{comment_id}', {
  gist_id: 'gist_id',
  comment_id: 42,
  body: 'body'
})

    Response

    Status: 200 OK
    {
  "id": 1,
  "node_id": "MDExOkdpc3RDb21tZW50MQ==",
  "url": "https://api.github.com/gists/a6db0bec360bb87e9418/comments/1",
  "body": "Just commenting for the sake of commenting",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2011-04-18T23:23:56Z",
  "updated_at": "2011-04-18T23:23:56Z",
  "author_association": "COLLABORATOR"
}

    Resource not found

    Status: 404 Not Found

    Delete a gist comment 

    delete /gists/{gist_id}/comments/{comment_id}

    参数

    Name Type In Description
    accept string header

    Setting to application/vnd.github.v3+json is recommended.
    gist_id string path

    gist_id parameter
    comment_id integer path

    comment_id parameter

    代码示例

    Shell
    curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  http(s)://{hostname}/api/v3/gists/GIST_ID/comments/42
    JavaScript (@octokit/core.js)
    await octokit.request('DELETE /gists/{gist_id}/comments/{comment_id}', {
  gist_id: 'gist_id',
  comment_id: 42
})

    Response

    Status: 204 No Content

    Not modified

    Status: 304 Not Modified

    Forbidden

    Status: 403 Forbidden

    Resource not found

    Status: 404 Not Found