Skip to main content
我们经常发布文档更新，此页面的翻译可能仍在进行中。有关最新信息，请访问英文文档。如果此页面上的翻译有问题，请告诉我们。
Enterprise Server 3.1
简体中文
� 
REST API
Enterprise Server 3.1
简体中文

� 

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

关注者

关于关注者 API

Many of the resources on this API provide a shortcut for getting information about the currently authenticated user. 如果请求 URL 不含 {username} 参数，则响应将是登录用户的响应（您必须随请求� 递身份验证信息）。 在通过基本身份验证或作用域为 user 的 OAuth 进行身份验证时，将包含其他私有信息，例如用户是否启用双重身份验证。

List followers of the authenticated user

Lists the people following the authenticated user.

参数

� �头
acceptstring

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

查询参数
per_pageinteger

The number of results per page (max 100).

默认值: 30

pageinteger

Page number of the results to fetch.

默认值: 1

HTTP 响应状态代� �

状态代� �描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

代� �示例

get/user/followers
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/user/followers

Response

Status: 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 } ]

List the people the authenticated user follows

Lists the people who the authenticated user follows.

参数

� �头
acceptstring

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

查询参数
per_pageinteger

The number of results per page (max 100).

默认值: 30

pageinteger

Page number of the results to fetch.

默认值: 1

HTTP 响应状态代� �

状态代� �描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

代� �示例

get/user/following
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/user/following

Response

Status: 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 } ]

Check if a person is followed by the authenticated user

参数

� �头
acceptstring

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

路径参数
usernamestring必选

The handle for the GitHub user account.

HTTP 响应状态代� �

状态代� �描述
204

if the person is followed by the authenticated user

304

Not modified

401

Requires authentication

403

Forbidden

404

if the person is not followed by the authenticated user

代� �示例

get/user/following/{username}
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/user/following/USERNAME

if the person is followed by the authenticated user

Status: 204

Follow a user

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

Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

参数

� �头
acceptstring

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

路径参数
usernamestring必选

The handle for the GitHub user account.

HTTP 响应状态代� �

状态代� �描述
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

代� �示例

put/user/following/{username}
curl \ -X PUT \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/user/following/USERNAME

Response

Status: 204

Unfollow a user

Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.

参数

� �头
acceptstring

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

路径参数
usernamestring必选

The handle for the GitHub user account.

HTTP 响应状态代� �

状态代� �描述
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

代� �示例

delete/user/following/{username}
curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/user/following/USERNAME

Response

Status: 204

List followers of a user

使用 GitHub Apps

Lists the people following the specified user.

参数

� �头
acceptstring

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

路径参数
usernamestring必选

The handle for the GitHub user account.

查询参数
per_pageinteger

The number of results per page (max 100).

默认值: 30

pageinteger

Page number of the results to fetch.

默认值: 1

HTTP 响应状态代� �

状态代� �描述
200

OK

代� �示例

get/users/{username}/followers
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/users/USERNAME/followers

Response

Status: 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 } ]

List the people a user follows

使用 GitHub Apps

Lists the people who the specified user follows.

参数

� �头
acceptstring

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

路径参数
usernamestring必选

The handle for the GitHub user account.

查询参数
per_pageinteger

The number of results per page (max 100).

默认值: 30

pageinteger

Page number of the results to fetch.

默认值: 1

HTTP 响应状态代� �

状态代� �描述
200

OK

代� �示例

get/users/{username}/following
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/users/USERNAME/following

Response

Status: 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 } ]

Check if a user follows another user

使用 GitHub Apps

参数

� �头
acceptstring

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

路径参数
usernamestring必选

The handle for the GitHub user account.

target_userstring必选

HTTP 响应状态代� �

状态代� �描述
204

if the user follows the target user

404

if the user does not follow the target user

代� �示例

get/users/{username}/following/{target_user}
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ http(s)://HOSTNAME/api/v3/users/USERNAME/following/TARGET_USER

if the user follows the target user

Status: 204