REST API 现在已版本化。 有关更多信息，请参阅 "关于 API 版本控制."
用于问题评论的 REST API 端点
使用 REST API 管理问题和拉取请求上的评论。
关于问题和拉取请求评论
您可以使用 REST API 创建和管理问题和拉取请求上的评论。每个拉取请求都是一个问题，但并非每个问题都是一个拉取请求。因此，在“问题”端点中提供了这两个功能的“共享”操作，例如管理受让人、标签和里程碑。要管理拉取请求审查评论，请参阅 "用于拉取请求审查评论的 REST API 端点."
列出仓库的问题评论
您可以使用 REST API 列出仓库中问题和拉取请求上的评论。每个拉取请求都是一个问题，但并非每个问题都是一个拉取请求。
默认情况下，问题评论按升序 ID 排序。
此端点支持以下自定义媒体类型。有关更多信息，请参阅 "媒体类型."
application/vnd.github.raw+json: 返回原始 Markdown 正文。响应将包含body。如果您没有传递任何特定媒体类型，这是默认值。application/vnd.github.text+json: 返回 Markdown 正文的纯文本表示形式。响应将包含body_text。application/vnd.github.html+json: 返回从正文的 Markdown 渲染的 HTML。响应将包含body_html。application/vnd.github.full+json: 返回原始、文本和 HTML 表示形式。响应将包含body、body_text和body_html。
用于“列出仓库的问题评论”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须至少具有以下权限集之一
- "Issues" 仓库权限（读取）
- "Pull requests" 仓库权限（读取）
如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。
"列出仓库的议题评论" 的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
owner string 必需仓库的帐户所有者。名称不区分大小写。 |
repo string 必需仓库的名称，不包括 |
| 名称、类型、描述 |
|---|
sort string 用于对结果进行排序的属性。 默认值： 可以是以下之一： |
direction string
可以是以下之一： |
since string 仅显示最后更新时间晚于给定时间的結果。这是一个 ISO 8601 格式的时间戳： |
per_page integer 每页的结果数量（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页"。 默认值： |
page integer 要获取的结果的页码。有关更多信息，请参阅 "在 REST API 中使用分页"。 默认值： |
获取仓库问题评论的 HTTP 响应状态码
| 状态码 | 描述 |
|---|---|
200 | OK |
404 | 资源未找到 |
422 | 验证失败或端点被刷屏。 |
获取仓库问题评论的代码示例
请求示例
get/repos/{owner}/{repo}/issues/comments
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/issues/comments响应
状态：200[ { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } ]获取问题评论
您可以使用 REST API 获取问题和拉取请求上的评论。每个拉取请求都是一个问题，但并非每个问题都是拉取请求。
此端点支持以下自定义媒体类型。有关更多信息，请参阅 "媒体类型."
application/vnd.github.raw+json: 返回原始 Markdown 正文。响应将包含body。如果您没有传递任何特定媒体类型，这是默认值。application/vnd.github.text+json: 返回 Markdown 正文的纯文本表示形式。响应将包含body_text。application/vnd.github.html+json: 返回从正文的 Markdown 渲染的 HTML。响应将包含body_html。application/vnd.github.full+json: 返回原始、文本和 HTML 表示形式。响应将包含body、body_text和body_html。
获取问题评论的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须至少具有以下权限集之一
- "Issues" 仓库权限（读取）
- "Pull requests" 仓库权限（读取）
如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。
获取问题评论的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
owner string 必需仓库的帐户所有者。名称不区分大小写。 |
repo string 必需仓库的名称，不包括 |
comment_id integer 必填评论的唯一标识符。 |
获取问题评论的 HTTP 响应状态码
| 状态码 | 描述 |
|---|---|
200 | OK |
404 | 资源未找到 |
获取问题评论的代码示例
请求示例
get/repos/{owner}/{repo}/issues/comments/{comment_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/issues/comments/COMMENT_ID响应
状态：200{ "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" }更新问题评论
您可以使用 REST API 更新问题和拉取请求上的评论。每个拉取请求都是一个问题，但并非每个问题都是拉取请求。
此端点支持以下自定义媒体类型。有关更多信息，请参阅 "媒体类型."
application/vnd.github.raw+json: 返回原始 Markdown 正文。响应将包含body。如果您没有传递任何特定媒体类型，这是默认值。application/vnd.github.text+json: 返回 Markdown 正文的纯文本表示形式。响应将包含body_text。application/vnd.github.html+json: 返回从正文的 Markdown 渲染的 HTML。响应将包含body_html。application/vnd.github.full+json: 返回原始、文本和 HTML 表示形式。响应将包含body、body_text和body_html。
用于“更新问题评论”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须至少具有以下权限集之一
- “问题”存储库权限（写入）
- “拉取请求”存储库权限（写入）
“更新问题评论”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
owner string 必需仓库的帐户所有者。名称不区分大小写。 |
repo string 必需仓库的名称，不包括 |
comment_id integer 必填评论的唯一标识符。 |
| 名称、类型、描述 |
|---|
body string 必需评论的内容。 |
“更新问题评论”的 HTTP 响应状态码
| 状态码 | 描述 |
|---|---|
200 | OK |
422 | 验证失败或端点被刷屏。 |
“更新问题评论”的代码示例
请求示例
patch/repos/{owner}/{repo}/issues/comments/{comment_id}
curl -L \ -X PATCH \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/issues/comments/COMMENT_ID \ -d '{"body":"Me too"}'响应
状态：200{ "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" }删除问题评论
您可以使用 REST API 删除问题和拉取请求上的评论。每个拉取请求都是一个问题，但并非每个问题都是拉取请求。
针对“删除问题评论”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须至少具有以下权限集之一
- “问题”存储库权限（写入）
- “拉取请求”存储库权限（写入）
“删除问题评论”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
owner string 必需仓库的帐户所有者。名称不区分大小写。 |
repo string 必需仓库的名称，不包括 |
comment_id integer 必填评论的唯一标识符。 |
“删除问题评论”的 HTTP 响应状态码
| 状态码 | 描述 |
|---|---|
204 | 无内容 |
“删除问题评论”的代码示例
请求示例
delete/repos/{owner}/{repo}/issues/comments/{comment_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/issues/comments/COMMENT_ID响应
状态：204列出问题评论
您可以使用 REST API 列出问题和拉取请求上的评论。每个拉取请求都是一个问题，但并非每个问题都是拉取请求。
问题评论按 ID 升序排列。
此端点支持以下自定义媒体类型。有关更多信息，请参阅 "媒体类型."
application/vnd.github.raw+json: 返回原始 Markdown 正文。响应将包含body。如果您没有传递任何特定媒体类型，这是默认值。application/vnd.github.text+json: 返回 Markdown 正文的纯文本表示形式。响应将包含body_text。application/vnd.github.html+json: 返回从正文的 Markdown 渲染的 HTML。响应将包含body_html。application/vnd.github.full+json: 返回原始、文本和 HTML 表示形式。响应将包含body、body_text和body_html。
针对“列出问题评论”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须至少具有以下权限集之一
- "Issues" 仓库权限（读取）
- "Pull requests" 仓库权限（读取）
如果仅请求公共资源，则无需身份验证或上述权限即可使用此端点。
“列出问题评论”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
owner string 必需仓库的帐户所有者。名称不区分大小写。 |
repo string 必需仓库的名称，不包括 |
issue_number 整数 必需标识问题的数字。 |
| 名称、类型、描述 |
|---|
since string 仅显示最后更新时间晚于给定时间的結果。这是一个 ISO 8601 格式的时间戳： |
per_page integer 每页的结果数量（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页"。 默认值： |
page integer 要获取的结果的页码。有关更多信息，请参阅 "在 REST API 中使用分页"。 默认值： |
“列出问题评论”的 HTTP 响应状态码
| 状态码 | 描述 |
|---|---|
200 | OK |
404 | 资源未找到 |
410 | 已消失 |
“列出问题评论”的代码示例
请求示例
get/repos/{owner}/{repo}/issues/{issue_number}/comments
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/issues/ISSUE_NUMBER/comments响应
状态：200[ { "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" } ]创建问题评论
您可以使用 REST API 在问题和拉取请求上创建评论。每个拉取请求都是一个问题，但并非每个问题都是拉取请求。
此端点会触发 通知。使用此端点过快地创建内容可能会导致二级速率限制。有关更多信息，请参阅“API 速率限制”和“使用 REST API 的最佳实践”。
此端点支持以下自定义媒体类型。有关更多信息，请参阅 "媒体类型."
application/vnd.github.raw+json: 返回原始 Markdown 正文。响应将包含body。如果您没有传递任何特定媒体类型，这是默认值。application/vnd.github.text+json: 返回 Markdown 正文的纯文本表示形式。响应将包含body_text。application/vnd.github.html+json: 返回从正文的 Markdown 渲染的 HTML。响应将包含body_html。application/vnd.github.full+json: 返回原始、文本和 HTML 表示形式。响应将包含body、body_text和body_html。
针对“创建问题评论”的细粒度访问令牌
此端点适用于以下细粒度令牌类型
细粒度令牌必须至少具有以下权限集之一
- “问题”存储库权限（写入）
- “拉取请求”存储库权限（写入）
“创建问题评论”的参数
| 名称、类型、描述 |
|---|
accept string 建议设置为 |
| 名称、类型、描述 |
|---|
owner string 必需仓库的帐户所有者。名称不区分大小写。 |
repo string 必需仓库的名称，不包括 |
issue_number 整数 必需标识问题的数字。 |
| 名称、类型、描述 |
|---|
body string 必需评论的内容。 |
“创建问题评论”的 HTTP 响应状态码
| 状态码 | 描述 |
|---|---|
201 | 已创建 |
403 | 禁止 |
404 | 资源未找到 |
410 | 已消失 |
422 | 验证失败或端点被刷屏。 |
“创建问题评论”的代码示例
请求示例
post/repos/{owner}/{repo}/issues/{issue_number}/comments
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/issues/ISSUE_NUMBER/comments \ -d '{"body":"Me too"}'响应
状态：201{ "id": 1, "node_id": "MDEyOklzc3VlQ29tbWVudDE=", "url": "https://api.github.com/repos/octocat/Hello-World/issues/comments/1", "html_url": "https://github.com/octocat/Hello-World/issues/1347#issuecomment-1", "body": "Me too", "user": { "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 }, "created_at": "2011-04-14T16:00:49Z", "updated_at": "2011-04-14T16:00:49Z", "issue_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", "author_association": "COLLABORATOR" }