我的 GitHub 设备的 REST API 端点是什么？

Question

我想使用 Groovy、HttpBuilder 和 REST API 访问我们公司的 onsidte GitHub 设备。 GitHub 开发者站点：https://developer.github.com/v3/, shows this URL: https://api.github.com. So if my company's GitHub URL is: http://github.mycompany.com，我的 REST API 端点 URL 是什么？例如如果我想列出所有用户，正确的 URL 是什么？

当我访问这个 URL: https://github.mycompany.com/api/v3 时，它给我一个错误：

github.mycompany.com 拒绝连接。 ERR_CONNECTION_REFUSED

Answer 1

根据“API Enterprise 2.5”：

All API endpoints—except Management Console API endpoints—are prefixed with the following URL:

https://hostname/api/v3/

但您需要进行身份验证：

Authentication

Your Enterprise installation's API endpoints accept the same authentication methods as the GitHub.com API. Specifically, you can authenticate yourself with OAuth tokens (which can be created using the Authorizations API) or basic authentication.

Every Enterprise API endpoint is only accessible to GitHub Enterprise site administrators, with the exception of the Management Console API, which is only accessible via the Management Console password.

Answer 2

如果您不使用 https，则为“http://github.mycompany.com/api/v3/”。

Answer 3

您收到该消息是因为请求未通过身份验证。

首先，您必须弄清楚您的服务器接受哪种身份验证，然后将其合并到您请求的 header 或（查询字符串）中。

例如，这是我获取我可以访问的组织的列表（使用 header 方法）的方式：

`url -k -H "Authorization: token xxxxxx...xxx" \ https://git.acme.com/api/v3/organizations`

请注意，xxxxx...xxx 是我使用 read-only 访问我的存储库创建的个人访问令牌的占位符。文档将此称为 OAUTH_TOKEN。您可以选择将令牌作为查询字符串插入。在这两种情况下，您都必须输入用户名，因为服务器会根据令牌计算出该用户名。

Answer 4

TLTR；这些是端点

+----+------------------------------------------+--------------------------------+
|    |                Enterprise                |             GitHub             |
+----+------------------------------------------+--------------------------------+
| v3 | https://[YOUR_HOST]/api/v3               | https://api.github.com         |
| v4 | https://[YOUR_HOST]/api/graphql          | https://api.github.com/graphql |
+----+------------------------------------------+--------------------------------+

例子

如果您想尝试，这里有一些示例。您需要创建一个 ACCESS_TOKEN

企业

curl -H "Authorization: bearer [ACCESS_TOKEN]" https://[YOUR_HOST]/api/v3/organizations
curl -H "authorization: bearer [ACCESS_TOKEN]" https://[YOUR_HOST]/api/graphql -d "{\"query\": \"query { viewer { login } }\"}"

GitHub

curl -H "Authorization: bearer [ACCESS_TOKEN]" https://api.github.com/organizations
curl -H "authorization: bearer [ACCESS_TOKEN]" https://api.github.com/graphql -d "{\"query\": \"query { viewer { login } }\"}"

Answer 5

如果你需要 https://github.com/google/shaka-player https://api.github.com/repos/google/shaka-player

更多信息请见 https://api.github.com/

  "current_user_url": "https://api.github.com/user",

  "current_user_authorizations_html_url": https://github.com/settings/connections/applications{/client_id}",

  "authorizations_url": "https://api.github.com/authorizations",

  "code_search_url": "https://api.github.com/search/code?q={query}{&page,per_page,sort,order}",

  "commit_search_url": "https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}",

  "emails_url": "https://api.github.com/user/emails",

  "emojis_url": "https://api.github.com/emojis",

  "events_url": "https://api.github.com/events",

  "feeds_url": "https://api.github.com/feeds",

  "followers_url": "https://api.github.com/user/followers",

  "following_url": "https://api.github.com/user/following{/target}",

  "gists_url": "https://api.github.com/gists{/gist_id}",

  "hub_url": "https://api.github.com/hub",

  "issue_search_url": "https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}",

  "issues_url": "https://api.github.com/issues",

  "keys_url": "https://api.github.com/user/keys",

  "label_search_url": "https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}",

  "notifications_url": "https://api.github.com/notifications",

  "organization_url": "https://api.github.com/orgs/{org}",

  "organization_repositories_url": "https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}",

  "organization_teams_url": "https://api.github.com/orgs/{org}/teams",

  "public_gists_url": "https://api.github.com/gists/public",

  "rate_limit_url": "https://api.github.com/rate_limit",

  "repository_url": "https://api.github.com/repos/{owner}/{repo}",

  "repository_search_url": "https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}",

  "current_user_repositories_url": "https://api.github.com/user/repos{?type,page,per_page,sort}",

  "starred_url": "https://api.github.com/user/starred{/owner}{/repo}",

  "starred_gists_url": "https://api.github.com/gists/starred",

  "topic_search_url": "https://api.github.com/search/topics?q={query}{&page,per_page}",

  "user_url": "https://api.github.com/users/{user}",

  "user_organizations_url": "https://api.github.com/user/orgs",

  "user_repositories_url": "https://api.github.com/users/{user}/repos{?type,page,per_page,sort}",

  "user_search_url": "https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"

我的 GitHub 设备的 REST API 端点是什么？

What's my GitHub appliance's REST API endpoint?

github-api

Authentication

例子