REST API 现在已版本化。 更多信息，请参阅“关于 API 版本控制”。

用于加星的 REST API 端点

使用 REST API 为代码库添加书签。

关于加星

您可以使用 REST API 为代码库加星（添加书签）。星标显示在代码库旁边，以显示大致的关注度。星标不会影响通知或活动提要。更多信息，请参阅“使用星标保存代码库”。

加星与关注

2012 年 8 月，我们更改了关注的工作方式。某些 API 客户端应用程序可能仍在使用原始的“观察者”端点来访问此数据。您现在应该改用“星标”端点（如下所述）。更多信息，请参阅“用于关注的 REST API 端点”和变更日志文章。

在 REST API 的响应中，watchers、watchers_count 和 stargazers_count 对应于已为代码库加星的用户数，而 subscribers_count 对应于关注者数。

列出加星用户

列出已为代码库加星的用户。

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

  • application/vnd.github.star+json：包含创建星标的时间戳。

“列出加星用户”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须具有以下权限集

  • “元数据”代码库权限（读取）

如果只请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出加星用户”的参数

标头
accept 字符串

建议设置为application/vnd.github+json。

路径参数
owner 字符串 必需

代码库的帐户所有者。名称不区分大小写。

repo 字符串 必需

代码库的名称，不包含.git扩展名。名称不区分大小写。

查询参数
per_page 整数

每页的结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 30

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 1

“列出加星用户”的 HTTP 响应状态代码

状态代码描述
200

OK

422

验证失败，或端点已被滥用。

“列出加星用户”的代码示例

请求示例

get/repos/{owner}/{repo}/stargazers
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/stargazers

默认响应

状态：200
[ { "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 } ]

列出经过身份验证的用户加星的代码库

列出经过身份验证的用户已加星的代码库。

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

  • application/vnd.github.star+json：包含创建星标的时间戳。

“列出经过身份验证的用户加星的代码库”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须具有以下权限集

  • “加星”用户权限（读取）

如果只请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出经过身份验证的用户加星的代码库”的参数

标头
accept 字符串

建议设置为application/vnd.github+json。

查询参数
sort 字符串

用于排序结果的属性。created 表示加星代码库的时间。updated 表示上次向代码库推送代码的时间。

默认值： created

可以是以下之一： created, updated

direction 字符串

排序结果的方向。

默认值： desc

可以是以下之一： asc, desc

per_page 整数

每页的结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 30

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 1

“列出经过身份验证的用户加星的代码库”的 HTTP 响应状态代码

状态代码描述
200

OK

304

未修改

401

需要身份验证

403

禁止

“列出经过身份验证的用户加星的代码库”的代码示例

请求示例

get/user/starred
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/starred

默认响应

状态：200
[ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "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 }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ]

检查认证用户是否收藏了某个仓库

认证用户是否已收藏该仓库。

“检查认证用户是否收藏了某个仓库”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须具有以下权限集

  • “元数据”仓库权限（读取） 和 “收藏”用户权限（读取）

“检查认证用户是否收藏了某个仓库”的参数

标头
accept 字符串

建议设置为application/vnd.github+json。

路径参数
owner 字符串 必需

代码库的帐户所有者。名称不区分大小写。

repo 字符串 必需

代码库的名称，不包含.git扩展名。名称不区分大小写。

“检查认证用户是否收藏了某个仓库”的HTTP响应状态码

状态代码描述
204

如果该仓库被您收藏，则返回此响应

304

未修改

401

需要身份验证

403

禁止

404

如果该仓库未被您收藏，则返回“未找到”

“检查认证用户是否收藏了某个仓库”的代码示例

请求示例

get/user/starred/{owner}/{repo}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/starred/OWNER/REPO

如果该仓库被您收藏，则返回此响应

状态：204

为认证用户收藏仓库

请注意，调用此端点时，需要将Content-Length设置为零。更多信息，请参见“HTTP 方法”。

“为认证用户收藏仓库”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须具有以下权限集

  • “收藏”用户权限（写入） 和 “元数据”仓库权限（读取）

“为认证用户收藏仓库”的参数

标头
accept 字符串

建议设置为application/vnd.github+json。

路径参数
owner 字符串 必需

代码库的帐户所有者。名称不区分大小写。

repo 字符串 必需

代码库的名称，不包含.git扩展名。名称不区分大小写。

“为认证用户收藏仓库”的HTTP响应状态码

状态代码描述
204

无内容

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

“为认证用户收藏仓库”的代码示例

请求示例

put/user/starred/{owner}/{repo}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/starred/OWNER/REPO

响应

状态：204

为认证用户取消收藏仓库

取消认证用户之前收藏的仓库。

“为认证用户取消收藏仓库”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须具有以下权限集

  • “收藏”用户权限（写入） 和 “元数据”仓库权限（读取）

“为认证用户取消收藏仓库”的参数

标头
accept 字符串

建议设置为application/vnd.github+json。

路径参数
owner 字符串 必需

代码库的帐户所有者。名称不区分大小写。

repo 字符串 必需

代码库的名称，不包含.git扩展名。名称不区分大小写。

“为认证用户取消收藏仓库”的HTTP响应状态码

状态代码描述
204

无内容

304

未修改

401

需要身份验证

403

禁止

404

资源未找到

“为认证用户取消收藏仓库”的代码示例

请求示例

delete/user/starred/{owner}/{repo}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/user/starred/OWNER/REPO

响应

状态：204

列出用户收藏的仓库

列出用户收藏的仓库。

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

  • application/vnd.github.star+json：包含创建星标的时间戳。

“列出用户收藏的仓库”的细粒度访问令牌

此端点与以下细粒度令牌类型一起使用:

细粒度令牌必须具有以下权限集

  • “加星”用户权限（读取）

如果只请求公共资源，则无需身份验证或上述权限即可使用此端点。

“列出用户收藏的仓库”的参数

标头
accept 字符串

建议设置为application/vnd.github+json。

路径参数
username 字符串 必需

GitHub 用户帐户的用户名。

查询参数
sort 字符串

用于排序结果的属性。created 表示加星代码库的时间。updated 表示上次向代码库推送代码的时间。

默认值： created

可以是以下之一： created, updated

direction 字符串

排序结果的方向。

默认值： desc

可以是以下之一： asc, desc

per_page 整数

每页的结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 30

page 整数

要获取的结果的页码。更多信息，请参阅“在 REST API 中使用分页”。

默认值： 1

“列出用户收藏的仓库”的HTTP响应状态码

状态代码描述
200

OK

“列出用户收藏的仓库”的代码示例

请求示例

get/users/{username}/starred
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/users/USERNAME/starred

默认响应

状态：200
[ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "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 }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "clone_url": "https://github.com/octocat/Hello-World.git", "mirror_url": "git:git.example.com/octocat/Hello-World", "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, "size": 108, "default_branch": "master", "open_issues_count": 0, "is_template": true, "topics": [ "octocat", "atom", "electron", "api" ], "has_issues": true, "has_projects": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "archived": false, "disabled": false, "visibility": "public", "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "allow_rebase_merge": true, "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "allow_auto_merge": false, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, "network_count": 0, "license": { "key": "mit", "name": "MIT License", "url": "https://api.github.com/licenses/mit", "spdx_id": "MIT", "node_id": "MDc6TGljZW5zZW1pdA==", "html_url": "https://github.com/licenses/mit" }, "forks": 1, "open_issues": 1, "watchers": 1 } ]