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

Question

据我所知,消息与提交相关联.但是当你在GitHub上查看一个repo时,它会帮助列出每个文件的消息,以及上次更改的时间.

我想在我拥有的回购的网页视图中复制它.看看GitHub api,在我看来,获取该信息的唯一方法是下载所有提交(可以被分页),并从最新的提交工作分配提交消息到本地缓存中的文件,进一步和进一步回到你收到每个文件的消息,可能是第一次提交,如果自初始提交以来没有更改任何文件

问题是,这是正确的方法吗？这甚至不会杀死5000 /小时的配额？

Answer 1

好的,在确定您需要的是每个文件的最新提交消息之后,您可以执行以下操作.

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

1)获取要列出文件的分支的引用对象:

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

您可能需要master分支,因此这是您将要发出的请求的示例:

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)使用您在上一步中收到的响应的属性获取引用指向的提交对象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)获取上一步中提取的提交对象的树对象.您将通过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参数,如所描述这里.我建议你使用这种方法,因为它只需要一个HTTP请求.

接下来,既然您拥有了repo中的文件和文件夹列表,您将获得最后一次更改每个文件/文件夹的提交.为此,请提出此请求

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请求.好消息是您可以缓存响应,这样您就不需要在没有任何更改的情况下发出请求(有关详细信息,请参阅此处).此外,您不会立即获取所有提交消息,您将在用户浏览文件夹时获取它们(就像在单击文件夹时一样在GitHub上).因此,您应该能够轻松地保持在5000个请求的范围内.

希望这可以帮助!如果你找到一个更容易的方法,让我知道:).我不知道是否有一种方法可以通过1-2个请求实现这一点,这可能是您的预期.