如何通过 GitHub API 获取存储库的分支计数？

Question

我是working on a UI，它列出了给定用户或组织的所有存储库。这是使用树形格式，其中第一级是存储库，第二级层次结构（子节点）是每个分支，如果展开的话。

我正在使用一种机制，它故意不要求我提取给定 repo 的所有分支的列表，因为 API 对 API 调用有速率限制。相反，我所要做的就是指示它包含多少个子节点，而不是实际为它们分配值（直到用户展开它的那一刻）。我几乎可以肯定，获取 repos 列表会在结果中包含分支计数，但令我失望的是，我没有看到它。我只能看到分叉、观星者、观察者、问题等的计数。除了分支计数之外的所有内容。

UI 的目的是它会提前知道填充子节点的分支数量，但直到 用户展开父节点后才真正获取它们 - 因此立即显示 每个分支的空占位符，然后异步加载要填充的实际分支。同样，因为我需要避免过多的 API 调用。当用户滚动时，它将使用分页只获取它需要向用户显示的页面，并保持缓存以供以后显示。

具体来说，我使用的是 Delphi 的 Virtual TreeView：

procedure TfrmMain.LstInitChildren(Sender: TBaseVirtualTree; Node: PVirtualNode;
  var ChildCount: Cardinal);
var
  L: Integer;
  R: TGitHubRepo;
begin
  L:= Lst.GetNodeLevel(Node);
  case L of
    0: begin
      //TODO: Return number of branches...
      R:= TGitHubRepo(Lst.GetNodeData(Node));
      ChildCount:= R.I['branch_count']; //TODO: There is no such thing!!!
    end;
    1: ChildCount:= 0; //Branches have no further child nodes
  end;
end;

我是否缺少某些东西，可以让我获得 repo 分支计数，而无需预先获取所有这些分支的完整列表？

Answer 1

您可以改用新的GraphQL API。这使您可以根据需要定制查询和结果。您可以在一个查询中完成这两项操作，而不是先获取计数然后再填写分支。

试试Query Explorer。

query {
  repository(owner: "octocat", name: "Hello-World") {
    refs(first: 100, refPrefix:"refs/heads/") {
      totalCount
      nodes {
        name
      }
    },
    pullRequests(states:[OPEN]) {
        totalCount
    }
  }
}

{
  "data": {
    "repository": {
      "refs": {
        "totalCount": 3,
        "nodes": [
          {
            "name": "master"
          },
          {
            "name": "octocat-patch-1"
          },
          {
            "name": "test"
          }
        ]
      },
      "pullRequests": {
        "totalCount": 192
      }
    }
  }
}

---

Pagination 使用游标完成。首先你得到第一页，一次最多 100 页，但为了简洁起见，我们在这里只使用 2 页。响应将包含一个唯一的光标。

{
  repository(owner: "octocat", name: "Hello-World") {
    pullRequests(first:2, states: [OPEN]) {
      edges {
        node {
          title
        }
        cursor
      }
    }
  }
}

{
  "data": {
    "repository": {
      "pullRequests": {
        "edges": [
          {
            "node": {
              "title": "Update README"
            },
            "cursor": "Y3Vyc29yOnYyOpHOABRYHg=="
          },
          {
            "node": {
              "title": "Just a pull request test"
            },
            "cursor": "Y3Vyc29yOnYyOpHOABR2bQ=="
          }
        ]
      }
    }
  }
}

然后您可以在光标后请求更多元素。这将获得接下来的 2 个元素。

{
  repository(owner: "octocat", name: "Hello-World") {
    pullRequests(first:2, after: "Y3Vyc29yOnYyOpHOABR2bQ==", states: [OPEN]) {
      edges {
        node {
          title
        }
        cursor
      }
    }
  }
}

---

Queries can be written like functions and passed arguments。参数以单独的 JSON 格式发送。这允许查询是一个简单的不变字符串。

这个查询和以前做的一样。

query NextPullRequestPage($pullRequestCursor:String) {
  repository(owner: "octocat", name: "Hello-World") {
    pullRequests(first:2, after: $pullRequestCursor, states: [OPEN]) {
      edges {
        node {
          title
        }
        cursor
      }
    }
  }
}

{
  "pullRequestCursor": "Y3Vyc29yOnYyOpHOABR2bQ=="
}

{ "pullRequestCursor": null } 将获取第一页。

---

它的rate limit calculations 比 REST API 更复杂。您每小时可获得 5000 积分，而不是每小时通话。每个查询花费一定数量的点数，大致对应于 Github 计算结果的成本。您可以通过询问其rateLimit 信息来了解查询的成本。如果你通过 dryRun: true 它只会告诉你成本而不运行查询。

{
  rateLimit(dryRun:true) {
    limit
    cost
    remaining
    resetAt
  }
  repository(owner: "octocat", name: "Hello-World") {
    refs(first: 100, refPrefix: "refs/heads/") {
      totalCount
      nodes {
        name
      }
    }
    pullRequests(states: [OPEN]) {
      totalCount
    }
  }
}

{
  "data": {
    "rateLimit": {
      "limit": 5000,
      "cost": 1,
      "remaining": 4979,
      "resetAt": "2019-08-21T05:13:56Z"
    }
  }
}

这个查询只需要一分。我还剩 4979 点，我将在 05:13 UTC 重置我的速率限制。

GraphQL API 非常灵活。您应该能够使用更少的 Github 资源和更少的编程来解决速率限制。