github - 在 GitHub API 上 - 获取与每个文件关联的最后提交消息的最佳方法是什么？

Question

据我了解，消息与提交相关。但是，当您查看 GitHub 上的存储库时，它会很有帮助地列出每个文件的消息以及上次更改的时间。

我想在我拥有的存储库的 WebView 中复制它。查看 GitHub api，在我看来，获取该信息的唯一方法是下载所有提交(可以分页)，并从最新的提交消息开始工作，将提交消息分配给文件您的本地缓存，越来越远，直到您获得每个文件的消息，如果自初始提交以来没有更改任何文件，则可能到第一次提交

问题是，这是正确的做法吗？这难道不会取消 5000/小时的配额吗？

Answer 1

好的，在弄清楚您需要的是每个文件的最新提交消息之后，您可以执行以下操作。

首先，获取存储库中的文件列表。为此，您需要:

1) fetch the reference object您要列出其文件的分支的名称:

GET https://api.github.com/repos/:owner/:repo/git/refs/heads/:branch

您可能需要主分支，因此这是您将提出的请求的示例:

https://api.github.com/repos/izuzak/pmrpc/git/refs/heads/master

您将得到的响应如下所示:

{
  "ref": "refs/heads/master",
  "url": "https://api.github.com/repos/izuzak/pmrpc/git/refs/heads/master",
  "object": {
    "sha": "fd6973f430a3367ad718ff049f1b075843913d6f",
    "type": "commit",
    "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/fd6973f430a3367ad718ff049f1b075843913d6f"
  }
}

2) fetch the commit object使用您在上一步中收到的响应的 object.url 属性来指向引用:

GET https://api.github.com/repos/izuzak/pmrpc/git/commits/fd6973f430a3367ad718ff049f1b075843913d6f

您将得到的响应如下所示:

{
  "sha": "fd6973f430a3367ad718ff049f1b075843913d6f",
  "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/fd6973f430a3367ad718ff049f1b075843913d6f",
  "html_url": "https://github.com/izuzak/pmrpc/commits/fd6973f430a3367ad718ff049f1b075843913d6f",
  "author": {
    "name": "Ivan Zuzak",
    "email": "izuzak@gmail.com",
    "date": "2013-04-09T08:55:45Z"
  },
  "committer": {
    "name": "Ivan Zuzak",
    "email": "izuzak@gmail.com",
    "date": "2013-04-09T08:55:45Z"
  },
  "tree": {
    "sha": "f5f5de80f67dd794ffbd4abb855fb7d1a573660e",
    "url": "https://api.github.com/repos/izuzak/pmrpc/git/trees/f5f5de80f67dd794ffbd4abb855fb7d1a573660e"
  },
  "message": "fix typos",
  "parents": [
    {
      "sha": "d3617ae56dda793131e743b2ff394984bbab6ca3",
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/d3617ae56dda793131e743b2ff394984bbab6ca3",
      "html_url": "https://github.com/izuzak/pmrpc/commits/d3617ae56dda793131e743b2ff394984bbab6ca3"
    }
  ]
}

3) fetch the tree object上一步中获取的提交对象的。您将通过上一步响应中提供的 tree.url 链接来执行此操作:

GET https://api.github.com/repos/izuzak/pmrpc/git/trees/f5f5de80f67dd794ffbd4abb855fb7d1a573660e

响应将如下所示:

{
  "sha": "f5f5de80f67dd794ffbd4abb855fb7d1a573660e",
  "url": "https://api.github.com/repos/izuzak/pmrpc/git/trees/f5f5de80f67dd794ffbd4abb855fb7d1a573660e",
  "tree": [
    {
      "mode": "100644",
      "type": "blob",
      "sha": "726f21a4adec8c24c2fab6cf5b455d094a8b21bf",
      "path": "LICENSE.markdown",
      "size": 568,
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/blobs/726f21a4adec8c24c2fab6cf5b455d094a8b21bf"
    },
    {
      "mode": "100644",
      "type": "blob",
      "sha": "eb94760b81441b34a73d1b085d9f153ae48b0e63",
      "path": "README.markdown",
      "size": 5772,
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/blobs/eb94760b81441b34a73d1b085d9f153ae48b0e63"
    },
    {
      "mode": "040000",
      "type": "tree",
      "sha": "2e72b217b8644ce6874cda03387a7ab2d8eee55e",
      "path": "examples",
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/trees/2e72b217b8644ce6874cda03387a7ab2d8eee55e"
    },
    {
      "mode": "100644",
      "type": "blob",
      "sha": "64b0dbe4981759c0f9640c8e882c97c7324fc798",
      "path": "pmrpc.js",
      "size": 24546,
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/blobs/64b0dbe4981759c0f9640c8e882c97c7324fc798"
    }
  ]
}

这些是存储库中的所有文件和文件夹。但请注意，对于文件夹，您将需要递归地获取文件夹树对象以获取文件夹中的文件列表。在上面的响应中，examples 是一个文件夹，您可以通过 type 属性的树值看到该文件夹​​。因此，您可以对文件夹提供的 url 进行另一个 GET 请求:

  GET https://api.github.com/repos/izuzak/pmrpc/git/trees/2e72b217b8644ce6874cda03387a7ab2d8eee55e

另一种方法是使用 recursive=1 参数，通过一次请求获取所有文件(所有文件夹中)的列表，如 here 中所述。 。我建议您使用这种方法，因为它只需要一个 HTTP 请求。

接下来，现在您已经有了存储库中的文件和文件夹列表，您将get the last commit更改了每个文件/文件夹。为此，请提出此请求

GET https://api.github.com/repos/:user/:repo/commits?path=FILE_OR_FOLDER_PATH

例如，这是一个获取上述 examples 文件夹提交的请求:

GET https://api.github.com/repos/izuzak/pmrpc/commits?path=examples

您将得到的响应是提交对象的列表，您应该只查看该列表中的第一个对象(因为您对文件的最后一次提交感兴趣)并检索 commit.message 属性来获取您需要的消息:

[
  {
    "sha": "3437f015257683a86e3b973b3279754df9ac2b24",
    "commit": {
      "author": { ... },
      "committer": { ... },
      "message": "change mode",
      "tree": { ... },
      "url": "https://api.github.com/repos/izuzak/pmrpc/git/commits/3437f015257683a86e3b973b3279754df9ac2b24",
      "comment_count": 0
    },
    ...
  },
  {
    ...
  }
]

在本例中，更改文件夹 examples 的最新提交的消息是“更改模式”。

因此，基本上，您需要发出 3 个 HTTP 请求来获取文件列表，然后为每个文件和文件夹发出 1 个 HTTP 请求。坏消息是，如果您有大量文件，您将发出大量 HTTP 请求。好消息是您可以缓存响应，这样如果没有任何更改，您就不需要发出请求(有关详细信息，请参阅 here)。此外，您不会立即获取所有提交消息，您将在用户浏览文件夹时获取它们(就像在 GitHub 上单击文件夹一样)。因此，您应该能够轻松地将请求限制在 5000 个以内。

希望这有帮助!如果您找到更简单的方法来做到这一点，请告诉我:)。我不知道是否有一种方法可以仅通过 1-2 个请求来实现此目的，这可能正是您所期望的。